RTCreateInfo class is used to specify the response creation information for an Generic RT study.
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearCorrection ()
	Clears the coil correction settings.

void	ClearMotionCorrection ()
	Clears the settings for correction of Motion conditions.

void	ClearOutputPort ()
	Clears output port settings.

void	ClearRangeParameter ()
	Clears calculation point settings.

String	GetAuthor ()
	Returns the RTT file author. More...

String	GetComment ()
	Returns comments for RTT files. More...

Variant	GetCorrectionCoilFluxlinkage (String &name)
	Returns the coil flux linkage correction for the coil. More...

Variant	GetCorrectionReferenceTemperature (String &name)
	Returns the coil reference temperature. More...

Variant	GetCorrectionTemperatureCoefficient (String &name)
	Returns the coil temperature correction factor. More...

Variant	GetCorrectionWinding (String &name)
	Returns the coil winding correction. More...

String	GetFolderPath ()
	Returns the RTT file output path. More...

String	GetLossFile ()
	Returns the file name in which the loss table is set. More...

Variant	GetMotionCorrection (String &name)
	Returns the correction value for the motion condition. More...

int	GetNumJobs ()
	Returns the number of simultaneous jobs. More...

int	GetOutputPortCalculationType (int index)
	Returns the calculation type of the response value set in the output port. More...

Variant	GetOutputPortCorrection (int index)
	Returns the collection value of the response value set in the output port. More...

String	GetOutputPortVariable (int index)
	Returns the variable name of the response value set in the output port. More...

bool	GetParameterPeriodic (String &name)
	Returns the periodic setting of the motion condition. More...

bool	GetSpecifyNumJobs ()
	Returns whether the number of simultaneous jobs is specified. More...

String	GetTitle ()
	Returns the RTT file title. More...

bool	IsIncludeGround ()
	Returns whether to include the Ground component connected to the neutral point of the star connection in the RTT file. More...

bool	IsPublicComment ()
	Returns whether to publish comments for RTT files. More...

bool	IsPublicOutputPort ()
	Returns whether to publish output ports for RTT files. More...

bool	IsPublicResolution ()
	Returns whether to publish calculation points for RTT files. More...

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

void	SetAuthor (String &author)
	Specifies the author of the RTT file. More...

void	SetComment (String &comment)
	Adds comments to the RTT file. More...

void	SetCorrection (String &name, Variant &tempCoeff, Variant &refTemp, Variant &winding, Variant &coilFlux)
	Specifies the coil correction value. More...

void	SetFolderPath (String &path)
	Specifies the path to export the RTT file. More...

void	SetIncludeGround (bool isInclude)
	Specifies a flag to include the Ground circuit component connected to the neutral point of the star connection in the RTT file. More...

void	SetLossFile (String &filename)
	Specifies the loss table. More...

void	SetMotionCorrection (String &name, Variant &correction)
	Specifies the correction value for Motion conditions. More...

void	SetNumJobs (int numJobs)
	Specifies the number of simultaneous jobs. More...

void	SetOutputPort (String &variable, int calculationType, Variant &correction)
	Specifies the response name and set the output port. More...

void	SetParameterDivisionsRange (String &name, int type, double start, double end, int divisions)
	Specifies the calculation range in the divided range to the calculation points. More...

void	SetParameterIncrementRange (String &name, int type, double start, double increment, int steps)
	Specifies the calculation range in the incremental range to the calculation points. More...

void	SetParameterPeriodic (String &name, bool periodic)
	Specifies the period in the Motion condition. More...

void	SetParameterTableRange (String &name, int type, String array &array)
	Specifies the calculation range in the table range to the calculation points. More...

void	SetPublicComment (bool isPublic)
	Specifies the flag to make RTT file comments public. More...

void	SetPublicOutputPort (bool isPublic)
	Specifies the flag to make RTT file output ports public. More...

void	SetPublicResolution (bool isPublic)
	Specifies the flag to make RTT file calculation points public. More...

void	SetSpecifyNumJobs (bool specify)
	Specifies whether to specify the number of simultaneous jobs. More...

void	SetTitle (String &title)
	Specifies the title of the RTT file. More...

Detailed Description

RTCreateInfo class is used to specify the response creation information for an Generic RT study.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCreateRTInfo()

Author: Author

Date: 金 9 1 2023

Member Function Documentation

String RTCreateInfo::GetAuthor ( )

Returns the RTT file author.

Returns: The author

String RTCreateInfo::GetComment ( )

Returns comments for RTT files.

Returns: The commnet

Variant RTCreateInfo::GetCorrectionCoilFluxlinkage ( String & name )

Returns the coil flux linkage correction for the coil.

Parameters

name	The title of the parameter

Returns: The coil flux linkage correction

Variant RTCreateInfo::GetCorrectionReferenceTemperature ( String & name )

Returns the coil reference temperature.

Parameters

name	The title of the parameter

Returns: The reference temperature

Variant RTCreateInfo::GetCorrectionTemperatureCoefficient ( String & name )

Returns the coil temperature correction factor.

Parameters

name	The title of the parameter

Returns: The temperature coefficient

Variant RTCreateInfo::GetCorrectionWinding ( String & name )

Returns the coil winding correction.

Parameters

name	The title of the parameter

Returns: The winding correction

String RTCreateInfo::GetFolderPath ( )

Returns the RTT file output path.

Returns: The output path

String RTCreateInfo::GetLossFile ( )

Returns the file name in which the loss table is set.

Returns: File name

Variant RTCreateInfo::GetMotionCorrection ( String & name )

Returns the correction value for the motion condition.

Parameters

name	The title of the parameter

Returns: correction value

int RTCreateInfo::GetNumJobs ( )

Returns the number of simultaneous jobs.

Returns: The number of simultaneous jobs.

int RTCreateInfo::GetOutputPortCalculationType ( int index )

Returns the calculation type of the response value set in the output port.

Parameters

index The index of port

Returns: The calculation type

Variant RTCreateInfo::GetOutputPortCorrection ( int index )

Returns the collection value of the response value set in the output port.

Parameters

index The index of port

Returns: The collection value

String RTCreateInfo::GetOutputPortVariable ( int index )

Returns the variable name of the response value set in the output port.

Parameters

index The index of port

Returns: The response value variable name

bool RTCreateInfo::GetParameterPeriodic ( String & name )

Returns the periodic setting of the motion condition.

Parameters

name	The title of the parameter

Returns: Periodic setting

bool RTCreateInfo::GetSpecifyNumJobs ( )

Returns whether the number of simultaneous jobs is specified.

Returns: Whether the number of simultaneous jobs is specified

String RTCreateInfo::GetTitle ( )

Returns the RTT file title.

Returns: The title

bool RTCreateInfo::IsIncludeGround ( )

Returns whether to include the Ground component connected to the neutral point of the star connection in the RTT file.

Returns: Whether to include a Ground circuit component

bool RTCreateInfo::IsPublicComment ( )

Returns whether to publish comments for RTT files.

Returns: Whether to publish or not

bool RTCreateInfo::IsPublicOutputPort ( )

Returns whether to publish output ports for RTT files.

Returns: Whether to publish or not

bool RTCreateInfo::IsPublicResolution ( )

Returns whether to publish calculation points for RTT files.

Returns: Whether to publish or not

bool RTCreateInfo::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the RTCreateInfo object is valid

void RTCreateInfo::SetAuthor ( String & author )

Specifies the author of the RTT file.

Parameters

author Author

void RTCreateInfo::SetComment ( String & comment )

Adds comments to the RTT file.

Parameters

comment Comment

void RTCreateInfo::SetCorrection	(	String &	name,
		Variant &	tempCoeff,
		Variant &	refTemp,
		Variant &	winding,
		Variant &	coilFlux
	)

Specifies the coil correction value.

Parameters

name	The title of the parameter
tempCoeff	The temperature coefficient
refTemp	The reference temperature
winding	The winding correction
coilFlux	The coil fluxlinkage correction

void RTCreateInfo::SetFolderPath ( String & path )

Specifies the path to export the RTT file.

Parameters

path	Output path

void RTCreateInfo::SetIncludeGround ( bool isInclude )

Specifies a flag to include the Ground circuit component connected to the neutral point of the star connection in the RTT file.

Parameters

isInclude

Whether to include a Ground circuit component

True=1 : Ground components are included.

False=0 : Ground components are not included.

void RTCreateInfo::SetLossFile ( String & filename )

Specifies the loss table.

Parameters

filename CSV file

void RTCreateInfo::SetMotionCorrection	(	String &	name,
		Variant &	correction
	)

Specifies the correction value for Motion conditions.

Parameters

name	The title of the parameter
correction	The correction value

void RTCreateInfo::SetNumJobs ( int numJobs )

Specifies the number of simultaneous jobs.

Parameters

numJobs Number of simultaneous jobs

void RTCreateInfo::SetOutputPort	(	String &	variable,
		int	calculationType,
		Variant &	correction
	)

Specifies the response name and set the output port.

Parameters

variable	Response value variable name
calculationType	Calculation method 0 : Minimum 1 : Maximum 2 : Simple Average 3 : Integral 4 : Sum
correction	The correction value

void RTCreateInfo::SetParameterDivisionsRange	(	String &	name,
		int	type,
		double	start,
		double	end,
		int	divisions
	)

Specifies the calculation range in the divided range to the calculation points.

Parameters

name	The title of the parameter
start	The start value of the range
end	The end value of the range
divisions	The number of divisions to divide the range

void RTCreateInfo::SetParameterIncrementRange	(	String &	name,
		int	type,
		double	start,
		double	increment,
		int	steps
	)

Specifies the calculation range in the incremental range to the calculation points.

Parameters

name	The title of the parameter
start	The start value of the range
increment	The increment value at each step
steps	The number of steps to increment the value

void RTCreateInfo::SetParameterPeriodic	(	String &	name,
		bool	periodic
	)

Specifies the period in the Motion condition.

Parameters

name	The title of the parameter
periodic	The periodic flag True=1 : Periodic is used False=0 : Periodic is not used

void RTCreateInfo::SetParameterTableRange	(	String &	name,
		int	type,
		String array &	array
	)

Specifies the calculation range in the table range to the calculation points.

Parameters

name	The title of the parameter
array	The table of values for the parameter

void RTCreateInfo::SetPublicComment ( bool isPublic )

Specifies the flag to make RTT file comments public.

Parameters

isPublic

The flag for making comments public

True=1 : Comments are published.

False=0 : Comments are not published.

void RTCreateInfo::SetPublicOutputPort ( bool isPublic )

Specifies the flag to make RTT file output ports public.

Parameters

isPublic

The flag for making output ports public

True=1 : Output port information is published.

False=0 : Output port information is not published.

void RTCreateInfo::SetPublicResolution ( bool isPublic )

Specifies the flag to make RTT file calculation points public.

Parameters

isPublic

The flag for making calculation points public

True=1 : Calculation points are published.

False=0 : Calculation points are not published.

void RTCreateInfo::SetSpecifyNumJobs ( bool specify )

Specifies whether to specify the number of simultaneous jobs.

Parameters

specify Specify the number of simultaneous jobs

void RTCreateInfo::SetTitle ( String & title )

Specifies the title of the RTT file.

Parameters

title Title

Public Member Functions

Detailed Description

Member Function Documentation