TableDefinition class is used to control display settings, such as elements and nodes, for specified results table.
The class can be called from Study class.
. More...

Public Member Functions
String	GetComponent ()
	Returns components. More...

Variant	GetComponentNames ()
	Returns a list of components. More...

String	GetCoordinateName ()
	Returns the name of the coordinate system. More...

int	GetOutputType ()
	Returns output type. More...

int	GetReferenceStep ()
	Returns the reference steps. More...

String	GetResultCoordinateNameList ()
	Returns a list of the coordinate systems. More...

String	GetResultType ()
	Returns the analysis result type as a string. More...

Variant	GetResultTypeNames ()
	Returns a list of result types that can be specified. More...

double	GetTemperature ()
	Returns the temperature. More...

String	GetUserComponentType ()
	Returns a list of analysis results that can be specified. More...

bool	IsShownMinMaxInfo ()
	Returns whether to output the maximum / minimum value. More...

bool	IsShownPositionInfo ()
	Returns whether to output the position information. More...

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

void	SetAllSteps ()
	Displays the results of all steps in the table.

void	SetComponent (String &name)
	Specifies components. More...

void	SetCoordinate (Variant &name)
	Specifies the reference coordinate system. More...

void	SetHistoryAllSteps ()
	Specifies the history function to refer to the all steps.

void	SetHistorySteps (String array &steps)
	Specifies the step referenced from the history function. More...

void	SetHistoryStepsByString (String &str)
	Specifies the steps to be referenced by the history function using a string. More...

void	SetIsShownMinMaxInfo (bool isShown)
	Specifies whether to output the maximum / minimum value. The default is to output. More...

void	SetIsShownPositionInfo (bool isShown)
	Specifies whether to output the position information. The default is to output the position information. More...

void	SetOutputType (int type)
	Specifies output type. More...

void	SetReferenceStep (int step)
	Specifies the reference steps. More...

void	SetResultType (String &typeName, String &sourceTitle=String())
	Specifies the analysis result type. More...

void	SetSteps (String array &steps)
	Specifies the step displayed in the results table. More...

void	SetStepsByInterval (int interval)
	Specifies the steps with regular intervals. More...

void	SetStepsByString (String &str)
	Specifies the steps displayed in the results table using a string. More...

void	SetTemperature (Variant &value)
	Specifies the temperature. More...

void	SetUserComponentType (String &name)
	Specifies the user component. More...

Detailed Description

TableDefinition class is used to control display settings, such as elements and nodes, for specified results table.
The class can be called from Study class.
.

Example of creating the class object:

app.GetModel(0).GetStudy(0).CreateTableDefinition()

Member Function Documentation

String TableDefinition::GetComponent ( )

Returns components.

Returns: Component

Variant TableDefinition::GetComponentNames ( )

Returns a list of components.

Returns: List of components

String TableDefinition::GetCoordinateName ( )

Returns the name of the coordinate system.

Returns: Name of the coordinate system

int TableDefinition::GetOutputType ( )

Returns output type.

Returns: Output type
0 : Displays real and imaginary parts in the result table

1 : Displays amplitude and phase in the result table

int TableDefinition::GetReferenceStep ( )

Returns the reference steps.

Returns: Step number

String TableDefinition::GetResultCoordinateNameList ( )

Returns a list of the coordinate systems.

Returns: List of coordinate systems

String TableDefinition::GetResultType ( )

Returns the analysis result type as a string.

Returns: The name of the analysis result type

For more information about analysis result types, see Properties for the Table Display.

Variant TableDefinition::GetResultTypeNames ( )

Returns a list of result types that can be specified.

Returns: List of analysis results types

double TableDefinition::GetTemperature ( )

Returns the temperature.

Returns: Temperature

String TableDefinition::GetUserComponentType ( )

Returns a list of analysis results that can be specified.

Returns: List of analysis types

bool TableDefinition::IsShownMinMaxInfo ( )

Returns whether to output the maximum / minimum value.

Returns: 0 : Does not output the maximum / minimum value

1 : Outputs the maximum / minimum value

bool TableDefinition::IsShownPositionInfo ( )

Returns whether to output the position information.

Returns: 0 : Does not output

1 : Outputs

bool TableDefinition::IsValid ( )

Returns True if an object is valid.

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

void TableDefinition::SetComponent ( String & name )

Specifies components.

Parameters

name Component

void TableDefinition::SetCoordinate ( Variant & name )

Specifies the reference coordinate system.

Parameters

name	Coordinate system

void TableDefinition::SetHistorySteps ( String array & steps )

Specifies the step referenced from the history function.

Parameters

steps Step number

void TableDefinition::SetHistoryStepsByString ( String & str )

Specifies the steps to be referenced by the history function using a string.

The steps can be specified either with a comma (e.g. 1,2,3) or by the range (e.g. 4-8).

Parameters

str	Step number(s)

void TableDefinition::SetIsShownMinMaxInfo ( bool isShown )

Specifies whether to output the maximum / minimum value. The default is to output.

Parameters

isShown

0 : Does not output the maximum / minimum value

1 : Outputs the maximum / minimum value

void TableDefinition::SetIsShownPositionInfo ( bool isShown )

Specifies whether to output the position information. The default is to output the position information.

Parameters

isShown

0 : Does not output the position information

1 : Outputs the position information

void TableDefinition::SetOutputType ( int type )

Specifies output type.

Parameters

type	Output type 0 : Displays real and imaginary parts in the result table 1 : Displays amplitude and phase in the result table

void TableDefinition::SetReferenceStep ( int step )

Specifies the reference steps.

Parameters

step	Step number

void TableDefinition::SetResultType	(	String &	typeName,
		String &	sourceTitle = `String()`
	)

Specifies the analysis result type.

Parameters

name	The analysis result type
sourceTitle	Title, such as "FFT calculation"

sourceTitle can be omitted.

For more information about analysis result types, see Properties for the Table Display.

void TableDefinition::SetSteps ( String array & steps )

Specifies the step displayed in the results table.

Parameters

steps Step number(s)

void TableDefinition::SetStepsByInterval ( int interval )

Specifies the steps with regular intervals.

Parameters

interval Intervals

void TableDefinition::SetStepsByString ( String & str )

Specifies the steps displayed in the results table using a string.

The steps can be specified either with a comma (e.g. 1,2,3) or by the range (e.g. 4-8).

Parameters

str	Step number(s)

void TableDefinition::SetTemperature ( Variant & value )

Specifies the temperature.

Parameters

value Temperature

void TableDefinition::SetUserComponentType ( String & name )

Specifies the user component.

Parameters

name	Name of the user component

Public Member Functions

Detailed Description

Member Function Documentation