GetProbes - MapleSim Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : MapleSim : MapleSim Application Programming Interface : API Commands : MapleSim/LinkModel/GetProbes

GetProbes

return the probes in the MapleSim model

 

Calling Sequence

Parameters

Options

Description

Examples

Calling Sequence

A := MapleSim:-LinkModel();

A:-GetProbes(opts)

Parameters

opts

-

(optional) equation(s) of the form option = value; specify options for GetProbes

Options

• 

sort = true or false

  

True means sort the probes lexicographically. The unsorted order matches the declaration order of the probes in the linked model, that is the order used by the Simulate command. The default is true.

• 

sortports = true or false

  

A synonym for the sort option.

Description

• 

A:-GetProbes returns a list of A's probes.

• 

The A := MapleSim:-LinkModel() statement needs to be run prior to successfully using any of the ModelObject A's export functions.

Examples

Linking to a MapleSim model (located in .msim file):

AMapleSim:-LinkModelfilename=catkerneloptstoolboxdir=MapleSim,/data/examples/RLCcircuit.msim:

Get the list of probes.

A:-GetProbes

Main.Probe1.Voutt

(1)

See Also

MapleSim

MapleSim[LinkModel]

MapleSim[LinkModel][GetPorts]