CircuitComponent class is used to specify the component properties of a circuit.
The class can be called from Circuit class.
. More...

Inherits ParameterList.

Public Member Functions
void	AddInstanceLink (String &propName, String &instanceName)
	Specifies reference component for a Thermal Resistor component. More...

void	ClearInstanceLink (String &propName)
	Clear reference component for a Resistor, a Switch or a Thermal Resistor component. More...

void	DeleteInstanceLink (String &propName, String &instanceName)
	Delete reference component for a Thermal Resistor component. More...

virtual String	GetFlagAsString (String &name)
	Returns the settings for the specified properties as a flag property name. More...

virtual String	GetFlagPropertyHelp (String &propName, Variant &val)
	Returns the help of the flag property as a string for the specified index or name. More...

FunctionObject *	GetFunction ()
	Returns FunctionObject that is set for the component. More...

String	GetInstanceLink (String &propName)
	Returns reference component for a Resistor, a Switch or a Thermal Resistor component. More...

Variant	GetKeyNames (String &name)
	Returns the flag name as a string list. More...

String	GetLink ()
	Returns the name of a circuit component linked to a condition in a circuit. More...

String	GetMacroTranslationKey ()
	Returns the key string of a macro circuit components. More...

String	GetName ()
	Returns the name of the component as a string. More...

virtual String	GetPropertyHelp (String &propName)
	Returns the help of the flag property as a string for the specified index or name. More...

Variant	GetPropertyNames ()
	Returns the list of all properties that can be specified for the condition. More...

String	GetPropertyTable ()
	Returns the list of properties including the type and help. More...

virtual String	GetPropertyType (String &propName)
	Returns a property type. More...

virtual String	GetStringValue (String &propName)
	Returns the value of the named property. More...

DataSet *	GetTable (String &propName)
	Returns the value of the specified table property. More...

DataSetList *	GetTableList (String &propName)
	Returns the table list of the specified property. More...

String	GetType ()
	Returns the type of the component as a string. More...

virtual double	GetValue (String &propName)
	Returns the value of property as a real number. More...

virtual double	GetValueWithUnit (String &propName, String &unitName)
	Returns the value of the named property as a real number in the specified unit. More...

virtual bool	IsValid ()
	Returns True if an object is valid. More...

virtual void	SetComplexValue (String &propName, double real, double imag)
	Specifies the value of the complex property. More...

virtual void	SetFlagByName (String &propName, String &scriptKeyName)
	Specifies the value of flag property for the specified name. More...

void	SetFunction (FunctionObject *func)
	Specifies FunctionObject for the component. More...

void	SetInstanceLink (String &propName, String &instanceName)
	Specifies reference component for a Resistor, a Switch or a Thermal Resistor component. More...

void	SetLink (String &name)
	Specifies a component link to another component. More...

void	SetName (String &name)
	Specifies the name of the component. More...

void	SetTable (String &propName, String array &mat)
	Specifies the value in the specified table for the properties. More...

void	SetTableFromFile (String &propName, String &filename)
	Specifies a point sequence for a property that is specified, by importing a point sequence file (.csv, .txt, *.pa). More...

void	SetTableList (String &propName, double primaryKey, String &primaryUnitName, String array &mat)
	Specifies the name for the dataset list (multiple tables). More...

void	SetTableListName (String &propName, String &name)
	Specifies the name for the dataset list (multiple tables). More...

void	SetTableListWithDualKey (String &propName, double primaryKey, String &primaryUnitName, double secondaryKey, String &secondaryUnitName, String array &mat)
	Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables). More...

void	SetTableProperty (String &propName, DataSet *set)
	Specifies a table for the specified properties. More...

void	SetTableWithUnit (String &propName, String array &mat, StringList &unitlist)
	Specifies the value of the specified table property. More...

void	SetTextTable (String &propName, String array &mat)
	Specifies the value in the specified string table for the properties. More...

virtual void	SetValue (String &propName, Variant &value)
	Specifies the value of the real number property or flag property. More...

void	SetValueWithPassword (String &propName, Variant &value, String &password)
	Specifies a filename and password. More...

virtual void	SetValueWithUnit (String &propName, double value, String &unitName)
	Specifies the value of the named property. More...

Detailed Description

CircuitComponent class is used to specify the component properties of a circuit.
The class can be called from Circuit class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetCircuit().GetComponent(0)

The property name and flag described in Properties and Flags for the Circuit Settings are used to specify the properties of each circuit component.

Member Function Documentation

void CircuitComponent::AddInstanceLink	(	String &	propName,
		String &	instanceName
	)

Specifies reference component for a Thermal Resistor component.

For a Thermal Resistor component, commands used when reference type is selected.

Parameters

propName	For a Thermal Resistor component, type of reference component "reference"= Reference component for reference type
instanceName	Name of the circuit component

void CircuitComponent::ClearInstanceLink ( String & propName )

Clear reference component for a Resistor, a Switch or a Thermal Resistor component.

For a Resistor or a Switch component, commands used when current dependency or voltage dependency type is selected. For a Thermal Resistor component, commands used when reference type is selected.

Parameters

propName	For a Resistor or a Switch component, type of reference component "reference"= Reference component for current dependency "terminal1"= 1st referenced electric potential probe for voltage dependency "terminal2"= 2nd referenced electric potential probe for voltage dependency For a Thermal Resistor component, type of reference component "reference"= Reference component for reference type
instanceName	Name of the circuit component

void CircuitComponent::DeleteInstanceLink	(	String &	propName,
		String &	instanceName
	)

Delete reference component for a Thermal Resistor component.

For a Thermal Resistor component, commands used when reference type is selected.

Parameters

propName	For a Thermal Resistor component, type of reference component "reference"= Reference component for reference type
instanceName	Name of the circuit component

String ParameterList::GetFlagAsString ( String & name )

virtualinherited

Returns the settings for the specified properties as a flag property name.

Parameters

name	Property name

Returns: DataSet object (table of properties)

String ParameterList::GetFlagPropertyHelp	(	String &	propName,
		Variant &	val
	)

virtualinherited

Returns the help of the flag property as a string for the specified index or name.

Parameters

propName	Property name
val	Flag index/Flag name

Returns: Help of the flag property

FunctionObject * CircuitComponent::GetFunction ( )

Returns FunctionObject that is set for the component.

For example, this command is used to specify the function parameter for the current source.

Returns: FunctionObject object

String CircuitComponent::GetInstanceLink ( String & propName )

Returns reference component for a Resistor, a Switch or a Thermal Resistor component.

For a Resistor or a Switch component, commands used when current dependency or voltage dependency type is selected. For a Thermal Resistor component, commands used when reference type is selected.

Parameters

propName

For a Resistor or a Switch component, type of reference component
"reference"= Reference component for current dependency
"terminal1"= 1st referenced electric potential probe for voltage dependency
"terminal2"= 2nd referenced electric potential probe for voltage dependency
For a Thermal Resistor component, type of reference component
"reference"= Reference component for reference type

Returns: Name of the circuit component

Variant ParameterList::GetKeyNames ( String & name )

inherited

Returns the flag name as a string list.

Parameters

name	Property name

Returns: Flag name

String CircuitComponent::GetLink ( )

Returns the name of a circuit component linked to a condition in a circuit.

Returns: Name of the circuit component

For details of the circuit components, see Circuit , CircuitComponent , CircuitComponentInstance , CircuitWire , and Properties and Flags for the Circuit Settings .
For instructions on how to link conditions to circuit components, see "Specifying the Linked FEM Coil in the Circuit" and Properties and Flags for the Circuit Settings .

String CircuitComponent::GetMacroTranslationKey ( )

Returns the key string of a macro circuit components.

Returns: translation key string

String CircuitComponent::GetName ( )

Returns the name of the component as a string.

Returns: Component name

String ParameterList::GetPropertyHelp ( String & propName )

virtualinherited

Returns the help of the flag property as a string for the specified index or name.

Parameters

propName Property name

Returns: Help of the property

Variant ParameterList::GetPropertyNames ( )

inherited

Returns the list of all properties that can be specified for the condition.

Returns: List of all properties for the condition

String ParameterList::GetPropertyTable ( )

inherited

Returns the list of properties including the type and help.

Returns: List of the properties

String ParameterList::GetPropertyType ( String & propName )

virtualinherited

Returns a property type.

Parameters

propName Property name

Returns: Property type

String ParameterList::GetStringValue ( String & propName )

virtualinherited

Returns the value of the named property.

Parameters

propName Property name

Returns: Property value

Reimplemented in StudyProperties.

DataSet * ParameterList::GetTable ( String & propName )

inherited

Returns the value of the specified table property.

Parameters

propName Property name

Returns: DataSet (table)

DataSetList * ParameterList::GetTableList ( String & propName )

inherited

Returns the table list of the specified property.

Parameters

propName Property name

Returns: DataSetList (table list)

String CircuitComponent::GetType ( )

Returns the type of the component as a string.

Returns: Component type name

double ParameterList::GetValue ( String & propName )

virtualinherited

Returns the value of property as a real number.

Parameters

propName Property name

Returns: Property value

double ParameterList::GetValueWithUnit	(	String &	propName,
		String &	unitName
	)

virtualinherited

Returns the value of the named property as a real number in the specified unit.

Parameters

propName	Property name
unitName	Unit

Returns: Property value

bool CircuitComponent::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the CircuitComponent objects in the list are valid

Reimplemented from ParameterList.

void ParameterList::SetComplexValue	(	String &	propName,
		double	real,
		double	imag
	)

virtualinherited

Specifies the value of the complex property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
real	Property value (real part)
imag	Property value (imaginary part)

void ParameterList::SetFlagByName	(	String &	propName,
		String &	scriptKeyName
	)

virtualinherited

Specifies the value of flag property for the specified name.

Parameters

propName	Property name
scriptKeyName	Flag name

void CircuitComponent::SetFunction ( FunctionObject * func )

Specifies FunctionObject for the component.

This command is used to specify a function for the component.

Parameters

func	FunctionObject object

void CircuitComponent::SetInstanceLink	(	String &	propName,
		String &	instanceName
	)

Specifies reference component for a Resistor, a Switch or a Thermal Resistor component.

For a Resistor or a Switch component, commands used when current dependency or voltage dependency type is selected. For a Thermal Resistor component, commands used when reference type is selected.

For a Resistor or a Switch component, type of reference component
"reference"= Reference component for current dependency
"terminal1"= 1st referenced electric potential probe for voltage dependency
"terminal2"= 2nd referenced electric potential probe for voltage dependency
For a Thermal Resistor component, type of reference component
"reference"= Reference component for reference type

Parameters

instanceName Name of the circuit component

void CircuitComponent::SetLink ( String & name )

Specifies a component link to another component.

Parameters

name	Circuit component name

void CircuitComponent::SetName ( String & name )

Specifies the name of the component.

Parameters

name	Component name

void ParameterList::SetTable	(	String &	propName,
		String array &	mat
	)

inherited

Specifies the value in the specified table for the properties.

Parameters

propName	Property name
mat	Multidimensional array

void ParameterList::SetTableFromFile	(	String &	propName,
		String &	filename
	)

inherited

Specifies a point sequence for a property that is specified, by importing a point sequence file (*.csv, *.txt, *.pa).

Parameters

propName	Property name
filename	Path for file that is imported

The following are example. Creates electric current condition and specifies point sequence for the time dependency current by using a file.

Set cond = study.CreateCondition("Current","current")
Call cond.SetValue("XType","Time")
Call cond.SetTableFromFile("Time","D:\sample_read_csv.csv")

The following file formats can be imported.

CSV file (*.csv):
This file can be edited using Microsoft Excel.
Text file (*.txt):
Point sequence file (*.pa)
This is table data that can be exported by JMAG-Studio.

void ParameterList::SetTableList	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		String array &	mat
	)

inherited

Specifies the name for the dataset list (multiple tables).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
mat	Multidimensional array

void ParameterList::SetTableListName	(	String &	propName,
		String &	name
	)

inherited

Specifies the name for the dataset list (multiple tables).

Parameters

propName	Property name
name	Dataset list name

void ParameterList::SetTableListWithDualKey	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		double	secondaryKey,
		String &	secondaryUnitName,
		String array &	mat
	)

inherited

Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
secondaryKey	Value of the secondary key
secondaryUnitName	Unit name of the secondary key
mat	Multidimensional array

void ParameterList::SetTableProperty	(	String &	propName,
		DataSet *	set
	)

inherited

Specifies a table for the specified properties.

Parameters

propName	Property name
set	DataSet (table)

void ParameterList::SetTableWithUnit	(	String &	propName,
		String array &	mat,
		StringList &	unitlist
	)

inherited

Specifies the value of the specified table property.

Parameters

propName	Property name
mat	Multidimensional array
unitlist	Unit list

void ParameterList::SetTextTable	(	String &	propName,
		String array &	mat
	)

inherited

Specifies the value in the specified string table for the properties.

Parameters

propName	Property name
mat	String multidimensional array

void CircuitComponent::SetValue	(	String &	propName,
		Variant &	value
	)

virtual

Specifies the value of the real number property or flag property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
value	Property value

Reimplemented from ParameterList.

void CircuitComponent::SetValueWithPassword	(	String &	propName,
		Variant &	value,
		String &	password
	)

Specifies a filename and password.

Parameters

propName	Property name
value	Property value
password	Property password

void ParameterList::SetValueWithUnit	(	String &	propName,
		double	value,
		String &	unitName
	)

virtualinherited

Specifies the value of the named property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
value	Property value
unitName	Unit

Public Member Functions

Detailed Description

Member Function Documentation