VectorExpression class is used to specify vector plots.
The class can be called from Study or AnalysisGroup class.
. More...

Public Member Functions
void	ClearParameter ()
	Clears the calculation range of the vector expression.

String	GetCaseRangeType ()
	Returns whether to perform calculations for each case of the vector equation. More...

int	GetDataSetIndex ()
	Returns the target data of vector expression. More...

String	GetEnd ()
	Returns the end point when the same calculation range is specified in all cases. More...

String	GetExpression ()
	Returns the expression of vector expression. More...

String	GetInterval ()
	Returns the section from the last step when the calculation target is from the last step to the specified section in all cases. More...

Variant	GetLine ()
	Returns the target line of vector expression. More...

String	GetName ()
	Returns the title for a vector expression. More...

String	GetPerCaseEnd (int index)
	Returns the end point when the same calculation range is specified in all cases. More...

String	GetPerCaseStart (int index)
	Returns the start point when the same calculation range is specified in all cases. More...

String	GetReferenceData ()
	Returns the referrer data title of vector expression. More...

String	GetStart ()
	Returns the start point when the same calculation range is specified in all cases. More...

String	GetType ()
	Returns the type of vector expression. More...

String	GetUnit ()
	Returns the units of the vector expression. More...

String	GetVariable ()
	Returns the variable of vector expression. More...

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

void	SetCaseRangeType (String &type)
	Specifies whether to perform calculation for each case of the vector expression. More...

void	SetDataSetIndex (int index)
	Specifies the target data for vector expression. More...

void	SetExpression (String &expression)
	Specifies the expression of the vector expression. More...

void	SetInterval (String &interval)
	Specifies the section from the last step when the calculation target is from the last step to the specified section in all cases. More...

void	SetLine (Variant &line)
	Specifies the target line for vector expression. More...

void	SetName (String &title)
	Specifies the title for a vector expression. More...

void	SetPerCaseRange (int index, String &start, String &end)
	Specifies the start point and end point for each case when specifying the calculation range for each case. More...

void	SetRange (String &start, String &end)
	Specifies the start point and end point when the same calculation range is specified in all cases. More...

void	SetReferenceDataFromCalculation (String &refData)
	Creates a vector expression by specifying the calculation name. More...

void	SetReferenceDataFromProbe (String &refData)
	Creates a vector expression by specifying the probe name. More...

void	SetReferenceDataFromSection (String &refData)
	Creates a vector expression by specifying the section graph name. More...

void	SetReferenceDataFromTable (String &refData)
	Creates a vector expression by specifying the table name. More...

void	SetType (String &type)
	Specifies the type of vector expression. More...

void	SetUnit (String &unit)
	Specifies the expression of the vector expression. More...

void	SetVariable (String &variable)
	Specifies the variable name of the vector expression. More...

Detailed Description

VectorExpression class is used to specify vector plots.
The class can be called from Study or AnalysisGroup class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetVectorExpression(0)

Member Function Documentation

String VectorExpression::GetCaseRangeType ( )

Returns whether to perform calculations for each case of the vector equation.

Returns: Calculation range type

int VectorExpression::GetDataSetIndex ( )

Returns the target data of vector expression.

Returns: Index of the data

String VectorExpression::GetEnd ( )

Returns the end point when the same calculation range is specified in all cases.

Returns: End point

String VectorExpression::GetExpression ( )

Returns the expression of vector expression.

Returns: Expression of vector expression

String VectorExpression::GetInterval ( )

Returns the section from the last step when the calculation target is from the last step to the specified section in all cases.

Returns: Section from the last step

Variant VectorExpression::GetLine ( )

Returns the target line of vector expression.

Returns: Name or index of the line

String VectorExpression::GetName ( )

Returns the title for a vector expression.

Returns: Name of the vector expression

String VectorExpression::GetPerCaseEnd ( int index )

Returns the end point when the same calculation range is specified in all cases.

Parameters

index Case index

Returns: End point

String VectorExpression::GetPerCaseStart ( int index )

Returns the start point when the same calculation range is specified in all cases.

Parameters

index Case index

Returns: Start point

String VectorExpression::GetReferenceData ( )

Returns the referrer data title of vector expression.

Returns: Reference source data title

String VectorExpression::GetStart ( )

Returns the start point when the same calculation range is specified in all cases.

Returns: Start point

String VectorExpression::GetType ( )

Returns the type of vector expression.

Returns: Type of vector expression

String VectorExpression::GetUnit ( )

Returns the units of the vector expression.

Returns: Unit of vector expression

String VectorExpression::GetVariable ( )

Returns the variable of vector expression.

Returns: Variable name of vector expression

bool VectorExpression::IsValid ( )

Returns True if an object is valid.

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

void VectorExpression::SetCaseRangeType ( String & type )

Specifies whether to perform calculation for each case of the vector expression.

Parameters

type	allsteps : Use all steps in all cases samevalue : Use same value for all cases interval : Specify the section from the last step percase : Specify values for each case

void VectorExpression::SetDataSetIndex ( int index )

Specifies the target data for vector expression.

Parameters

value Index of the data

void VectorExpression::SetExpression ( String & expression )

Specifies the expression of the vector expression.

Parameters

expression Expression of the vector expression

Set for expression type vector expression.

void VectorExpression::SetInterval ( String & interval )

Specifies the section from the last step when the calculation target is from the last step to the specified section in all cases.

Parameters

interval Section from the last step

void VectorExpression::SetLine ( Variant & line )

Specifies the target line for vector expression.

Parameters

value Name or index of the line

void VectorExpression::SetName ( String & title )

Specifies the title for a vector expression.

Parameters

name	Name of the vector expression

void VectorExpression::SetPerCaseRange	(	int	index,
		String &	start,
		String &	end
	)

Specifies the start point and end point for each case when specifying the calculation range for each case.

Parameters

index	Case index
start	Start point
end	End point

void VectorExpression::SetRange	(	String &	start,
		String &	end
	)

Specifies the start point and end point when the same calculation range is specified in all cases.

Parameters

start	Start point
end	End point

void VectorExpression::SetReferenceDataFromCalculation ( String & refData )

Creates a vector expression by specifying the calculation name.

Parameters

refData Calculation name

void VectorExpression::SetReferenceDataFromProbe ( String & refData )

Creates a vector expression by specifying the probe name.

Parameters

refData Probe name

void VectorExpression::SetReferenceDataFromSection ( String & refData )

Creates a vector expression by specifying the section graph name.

Parameters

refData Section graph name

void VectorExpression::SetReferenceDataFromTable ( String & refData )

Creates a vector expression by specifying the table name.

Parameters

refData Table name

void VectorExpression::SetType ( String & type )

Specifies the type of vector expression.

Parameters

type	Type of vector expression

Enter "DataVariable" to create from a dataset or "Expression" to create an expression.

void VectorExpression::SetUnit ( String & unit )

Specifies the expression of the vector expression.

Parameters

unit	Unit of vector expression

void VectorExpression::SetVariable ( String & variable )

Specifies the variable name of the vector expression.

Parameters

variable Variable name

Public Member Functions

Detailed Description

Member Function Documentation