Step class is used for step control settings.
The class can be called from Study class
. More...

Inherits ParameterList.

Public Member Functions
void	AddSubCondition (Variant &val, int subIndex)
	Inserts the steady state condition by specifying the name or index. More...

Condition *	CreateSubCondition (String &typeName, String &name)
	Returns a Condition object by specifying the type name and name. 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...

String	GetInstanceLink (String &propName)
	Returns circuit component name related to the step control. More...

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

String	GetLinkWithType (String &type)
	Returns the names of the conditions and circuit components that are linked. 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...

Condition *	GetSubCondition (Variant &val)
	Returns a Condition object of the steady state condition by specifying the name or index. 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...

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...

void	InsertSubCondition (Condition *condition, int subIndex)
	Inserts the steady state condition by specifying the Condition object. More...

void	InsertSubConditionByIndex (int conditionIndex, int subIndex)

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

int	NumSubConditions ()
	Returns the number of steady state conditions as an integer. More...

void	RemoveSubCondition (Variant &val)
	Deletes the steady state condition by specifying the name or index. 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	SetInstanceLink (String &propName, Variant &val)
	Specifies circuit components that are related to step control. More...

void	SetLinkWithType (Variant &type, Variant &val)
	Specifies the condition and circuit component to link to the step constrol. 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...

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

Detailed Description

Step class is used for step control settings.
The class can be called from Study class
.

Example of calling the class object:

app.GetModel(0).GetStudy().GetStep()

See below for properties that can be set in Step.

Member Function Documentation

void Step::AddSubCondition	(	Variant &	val,
		int	subIndex
	)

Inserts the steady state condition by specifying the name or index.

Parameters

val	Name or Index of the condition to insert
subIndex	Index of the steady state conditions

Condition * Step::CreateSubCondition	(	String &	typeName,
		String &	name
	)

Returns a Condition object by specifying the type name and name.

This command is used to create the Steady State condition.

Parameters

typeName	Condition type name
name	Condition name

Returns: Condition object

For information about the condition type name that can be specified as the argument "typeName", only "SteadyState".

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

String Step::GetInstanceLink ( String & propName )

Returns circuit component name related to the step control.

Parameters

propName

ResistorID : Resistor component ID

ThermalProbeID : Thermal probe component ID

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 Step::GetLinkWithType ( String & type )

Returns the names of the conditions and circuit components that are linked.

Parameters

type	Type name Resistance : Resistor component FEM coil : FEM Coil condition

Returns: Names of the conditions/circuit components

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.

Condition * Step::GetSubCondition ( Variant & val )

Returns a Condition object of the steady state condition by specifying the name or index.

Parameters

val	Name or index of the condition

Returns: Condition object

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)

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

void Step::InsertSubCondition	(	Condition *	condition,
		int	subIndex
	)

Inserts the steady state condition by specifying the Condition object.

Parameters

condition	Condition object
subIndex	Index of the steady state condition

void Step::InsertSubConditionByIndex	(	int	conditionIndex,
		int	subIndex
	)

Deprecated:

Inserts the steady state condition by specifying the indexes.

Parameters

conditionIndex	Index of the condition to insert.
subIndex	Index of the steady state condition

bool Step::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the Step object is valid

Reimplemented from ParameterList.

int Step::NumSubConditions ( )

Returns the number of steady state conditions as an integer.

Returns: Number of conditions in the study

void Step::RemoveSubCondition ( Variant & val )

Deletes the steady state condition by specifying the name or index.

Returns: Name or index of the condition

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 Step::SetInstanceLink	(	String &	propName,
		Variant &	val
	)

Specifies circuit components that are related to step control.

Parameters

propName	ResistorID : Resistor component ID ThermalProbeID : Thermal Probe component ID
val	Name or index of the circuit component

void Step::SetLinkWithType	(	Variant &	type,
		Variant &	val
	)

Specifies the condition and circuit component to link to the step constrol.

Parameters

type	Type name Resistance : Resistor component FEM coil : FEM Coil condition
val	Condition name, circuit component name or index

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 ParameterList::SetValue	(	String &	propName,
		Variant &	value
	)

virtualinherited

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 in CircuitComponent, and StudyProperties.

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