GetVariables - MapleSim Help

Online Help

All Products    Maple    MapleSim


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

GetVariables

Get the variables of the active MapleSim subsystem

 

Calling Sequence

Parameters

Returns

Options

Description

Examples

Calling Sequence

A := MapleSim:-LinkModel();

A:-GetVariables(options);

Parameters

options

-

(optional) equation(s) of the form name = value

Returns

• 

list : list of the active subsystem/s variables.

Options

• 

toplevel : true or false

  

Specifies whether the top-level variables should be returned regardless of the active subsystem setting. Default is false.

• 

daeonly : true or false

  

Specifies whether to return variables appearing only in the core continuous equations ("daes"). See MapleSim[LinkModel][GetEquations] for more details. Default is true.

• 

nosubs : true or false

  

Specifies whether variable substitutions will be applied to the returned variable set.  Default is false.

• 

inputs : set or list of variables

  

Specifies which variables should be treated as inputs when equations are simplified. Used with subsystems with acausal ports when daeonly=true because changing which variables are treated as inputs may affect the core DAE equations, and, hence, the variables that appear in it. Input signal port variables are always treated as inputs. In addition, by default, the across (potential) variables of acausal ports are treated as inputs. If the inputs option is passed, only the signal inputs and the variables specified by inputs are treated as inputs.

• 

params : one of the following: set, list or 'all'

  

Specifies which parameters to leave symbolic when determining a core DAE system. This option is needed only when daeonly=true because the choice of which parameters are left symbolic may affect the resulting core DAE system, and , hence, the variables in it. By default, only parameters explicitly defined on the active subsystem are left symbolic.

Description

• 

A:-GetVariables returns a list of A's active subsystem's variables. If no subsystem is active, or the option toplevel is specified, the command returns the variables defined for the entire model.

• 

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:-LinkModel'filename'=catkernelopts'toolboxdir'=MapleSim,/data/examples/RLCcircuit.msim:

Getting the variables of the active subsystem:

A:-GetVariables

C1_p_it,I1_p_it,SC1_n_vt

(1)

See Also

MapleSim

MapleSim[LinkModel]

 


Download Help Document

Was this information helpful?



Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam