Public Member Functions | List of all members
DynamicCircuit Class Reference

DynamicCircuit class is used to specify the properties of macro components.
The class can be created from Circuit class.
. More...

Public Member Functions

bool IsValid ()
 Returns True if an object is valid. More...
 
void SetValue (String &name, Variant &value)
 Specifies a value for the property. More...
 
CircuitComponentInstanceSubmit (String &name, int x, int y)
 Creates a macro component with the specified name. More...
 

Detailed Description

DynamicCircuit class is used to specify the properties of macro components.
The class can be created from Circuit class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCircuit().CreateDynamicCircuit("cage")

Member Function Documentation

bool DynamicCircuit::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the DynamicCircuit objects in the list are valid
void DynamicCircuit::SetValue ( String &  name,
Variant &  value 
)

Specifies a value for the property.

Parameters
nameProperty name
valueValue for the property
CircuitComponentInstance * DynamicCircuit::Submit ( String &  name,
int  x,
int  y 
)

Creates a macro component with the specified name.

Parameters
nameMacro component name
xX-coordinate
yY-coordinate
Returns
CircuitComponentInstance object