ResultDefinition class defines common members when specifying each plot setting.
. More...

Inherited by ContourDefinition, FluxLineDefinition, and VectorDefinition.

Public Member Functions
void	AddCutPlane (Variant &index)
	Specifies the index or name of cutting plane. More...

void	ClearCutPlanes ()
	Clears the setting of displayed cutting plane.

String	DigitsNotationTypeName ()
	Returns type of numerical value display for the indicator on the scale bar. More...

bool	GetAutoScale ()
	Returns True as a return value if the automatic scale is set. More...

StringList	GetCutPlaneList ()
	Returns the list of cutting plane index. More...

bool	GetDisplayScaleBar ()
	Returns True if user wants to display the scale bar. More...

String	GetGradientName ()
	Returns the name of the gradation type as a string. More...

Variant	GetGradientNames ()
	Returns the list of the gradation types. More...

int	GetLeftPosition ()
	Returns Left position specified by the user. More...

int	GetLevels ()
	Returns the number of color levels as an integer. More...

bool	GetLogScale ()
	Returns the scaling type. If the logarithmic scale is used, True will be returned. More...

double	GetMax ()
	Returns the maximum value as a real number. More...

double	GetMin ()
	Returns the minimum value as a real number. More...

bool	GetModelCopy ()
	Returns the display flag of model copy. More...

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

int	GetNumLabels ()
	Returns the number of labels in the scale bar. More...

String	GetResultCoordinateName ()
	Returns the coordinate system name applied to the contour display. More...

String	GetResultCoordinateNameList ()
	Returns the list of the coordinate systems which can be applied to contour. More...

virtual String	GetResultType ()
	Returns the name of the result type as a string. More...

Variant	GetResultTypeNames ()
	Returns the list of the result types. More...

Condition *	GetScalingFactor ()
	Returns the scaling condition is set. More...

bool	GetSmooth ()
	Returns True as a return value if smoothing is set. More...

int	GetTopPosition ()
	Returns Top position specified by the user. More...

bool	GetTransparencyNonTarget ()
	Returns the transparency flag of non target parts. More...

int	GetTransparencyValueNonTarget ()
	Returns the transparency of non target parts. More...

bool	GetUseSpecifiedPosition ()
	Returns True if user wants to specify the position for the scale bar. More...

int	GetViewIndex ()
	Returns the index of view setting. More...

bool	GetViewOriginalModel ()
	Returns the display flag of original model. More...

bool	GetViewPoint ()
	Returns the view point flag. More...

bool	GetViewScale ()
	Returns the display flag of scaling. More...

bool	IsEditMode ()
	Returns whether it is in edit mode. More...

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

int	Precision ()
	Returns the displayed digit that is after the decimal point. More...

void	SetAutoScale (bool scale)
	Specifies the flag for the automatic scale. More...

void	SetDigitsNotationType (Variant &type)
	Specifies the type of numerical value display for the indicator on the scale bar. More...

void	SetDisplayScaleBar (bool displayScaleBar)
	Specifies whether or not to display the scale bar. More...

void	SetEditMode ()
	Specifies the edit mode for batch settings. After calling the SetEditMode function, the result item is not updated until the Update function is called.

void	SetGradient (String &name, Variant &levels, bool smooth)
	Specifies the argument to specify the color gradation. More...

void	SetLogScale (bool logscale)
	Specifies the scaling type. If the value is set to True , the scaling will be a logarithmic scale. More...

void	SetModelCopy (bool on)
	Specifies the display flag of model copy. More...

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

void	SetNumLabels (Variant &labels)
	Specifies the number of labels in the scale bar. More...

void	SetPrecision (Variant &precision)
	Specifies the displayed digit that is after the decimal point for the indicator on the scale bar. More...

void	SetRange (Variant &min, Variant &max)
	Specifies the range between the minimum and maximum values. More...

void	SetResultCoordinate (Variant &name)
	Returns the coordinate system name applied to the contour display. More...

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

void	SetScaleBarPosition (Variant &leftPos, Variant &topPos)
	Specifies the scale bar position. More...

void	SetScalingFactor (Condition *cond)
	Specifies Condition object for scaling. More...

void	SetTransparencyNonTarget (bool on)
	Specifies the transparency flag of non target parts. More...

void	SetTransparencyValueNonTarget (Variant &value)
	Specifies the transparency of non target parts. More...

void	SetUseSpecifiedPosition (bool useSpecifiedPosition)
	Specifies whether or not to use the specified position of the scale bar. More...

void	SetViewIndex (Variant &index)
	Specifies the index of view setting. More...

void	SetViewName (Variant &name)
	Specifies the name of view setting. More...

void	SetViewOriginalModel (bool on)
	Specifies the display flag of original model. More...

void	SetViewPoint (bool on)
	Specifies the flag of view point. More...

void	SetViewScale (bool on)
	Specifies the display flag of scaling. More...

void	Update ()
	Cancels edit mode and performs update processing. Script error when calling outside edit mode.

Detailed Description

ResultDefinition class defines common members when specifying each plot setting.
.

The object can be used as a inhereted class when specifying contour, vector and flux line definitions.

Member Function Documentation

void ResultDefinition::AddCutPlane ( Variant & index )

Specifies the index or name of cutting plane.

Parameters

index Index or name of cutting plane

String ResultDefinition::DigitsNotationTypeName ( )

Returns type of numerical value display for the indicator on the scale bar.

Returns: Type of numerical value display

automatic ： Automatic

sientific ： Exponent display

decimal ： Decimal display

bool ResultDefinition::GetAutoScale ( )

Returns True as a return value if the automatic scale is set.

Returns: Automatic ON/OFF status of scale

StringList ResultDefinition::GetCutPlaneList ( )

Returns the list of cutting plane index.

Returns: List of cutting plane index

bool ResultDefinition::GetDisplayScaleBar ( )

Returns True if user wants to display the scale bar.

Returns: Whether or not to display the scale bar

String ResultDefinition::GetGradientName ( )

Returns the name of the gradation type as a string.

Returns: Name of the gradation type

Variant ResultDefinition::GetGradientNames ( )

Returns the list of the gradation types.

Returns: List of the gradation types

int ResultDefinition::GetLeftPosition ( )

Returns Left position specified by the user.

Returns: Left position specified by the user

int ResultDefinition::GetLevels ( )

Returns the number of color levels as an integer.

Returns: Number of color levels

bool ResultDefinition::GetLogScale ( )

Returns the scaling type. If the logarithmic scale is used, True will be returned.

Returns: Logarithmic scale ON/OFF

double ResultDefinition::GetMax ( )

Returns the maximum value as a real number.

Returns: Maximum value

double ResultDefinition::GetMin ( )

Returns the minimum value as a real number.

Returns: Minimum value

bool ResultDefinition::GetModelCopy ( )

Returns the display flag of model copy.

Returns: Display flag of model copy

String ResultDefinition::GetName ( )

Returns the name of the plot as a string.

Returns: Plot name

int ResultDefinition::GetNumLabels ( )

Returns the number of labels in the scale bar.

Returns: Number of labels in the scale bar

String ResultDefinition::GetResultCoordinateName ( )

Returns the coordinate system name applied to the contour display.

Returns: Name of the coordinate system

String ResultDefinition::GetResultCoordinateNameList ( )

Returns the list of the coordinate systems which can be applied to contour.

Returns: List of the coordinate systems

String ResultDefinition::GetResultType ( )

virtual

Returns the name of the result type as a string.

Returns: Name of the result type

Reimplemented in FluxLineDefinition.

Variant ResultDefinition::GetResultTypeNames ( )

Returns the list of the result types.

Returns: List of the result types

Condition * ResultDefinition::GetScalingFactor ( )

Returns the scaling condition is set.

Returns: Condition object

bool ResultDefinition::GetSmooth ( )

Returns True as a return value if smoothing is set.

Returns: Smoothing ON/OFF

int ResultDefinition::GetTopPosition ( )

Returns Top position specified by the user.

Returns: Top position specified by the user

bool ResultDefinition::GetTransparencyNonTarget ( )

Returns the transparency flag of non target parts.

Returns: Transparency

int ResultDefinition::GetTransparencyValueNonTarget ( )

Returns the transparency of non target parts.

Returns: Transparency

bool ResultDefinition::GetUseSpecifiedPosition ( )

Returns True if user wants to specify the position for the scale bar.

Returns: Whether or not to use the position specifed by the user

int ResultDefinition::GetViewIndex ( )

Returns the index of view setting.

Returns: Index of view setting

bool ResultDefinition::GetViewOriginalModel ( )

Returns the display flag of original model.

Returns: Display flag of original model

bool ResultDefinition::GetViewPoint ( )

Returns the view point flag.

Returns: View point flag

bool ResultDefinition::GetViewScale ( )

Returns the display flag of scaling.

Returns: Display flag of scaling

bool ResultDefinition::IsEditMode ( )

Returns whether it is in edit mode.

Returns: Whether in edit mode

bool ResultDefinition::IsValid ( )

Returns True if an object is valid.

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

int ResultDefinition::Precision ( )

Returns the displayed digit that is after the decimal point.

Returns: Display digit after the decimal point

void ResultDefinition::SetAutoScale ( bool scale )

Specifies the flag for the automatic scale.

Parameters

scale ON/OFF

void ResultDefinition::SetDigitsNotationType ( Variant & type )

Specifies the type of numerical value display for the indicator on the scale bar.

Parameters

type	Type of numerical value display automatic ： Automatic sientific ： Exponent display decimal ： Decimal display

void ResultDefinition::SetDisplayScaleBar ( bool displayScaleBar )

Specifies whether or not to display the scale bar.

Parameters

displayScaleBar Flag for whether or not to display the scale bar.

void ResultDefinition::SetGradient	(	String &	name,
		Variant &	levels,
		bool	smooth
	)

Specifies the argument to specify the color gradation.

Parameters

name	Gradation: PurpleRed BlueRed GrayScale CMR
levels	Number of levels
smooth	Smooth color band

void ResultDefinition::SetLogScale ( bool logscale )

Specifies the scaling type. If the value is set to True , the scaling will be a logarithmic scale.

Parameters

logscale

True=1 : Logarithmic scale

False=0 : Linear scale

void ResultDefinition::SetModelCopy ( bool on )

Specifies the display flag of model copy.

Parameters

on	Display flag of model copy

void ResultDefinition::SetName ( String & name )

Specifies the name of the plot.

Parameters

name Plot name

void ResultDefinition::SetNumLabels ( Variant & labels )

Specifies the number of labels in the scale bar.

Parameters

labels Number of labels

void ResultDefinition::SetPrecision ( Variant & precision )

Specifies the displayed digit that is after the decimal point for the indicator on the scale bar.

Parameters

Precision Display digit after the decimal point

void ResultDefinition::SetRange	(	Variant &	min,
		Variant &	max
	)

Specifies the range between the minimum and maximum values.

Parameters

min	Minimum value
max	Maximum value

void ResultDefinition::SetResultCoordinate ( Variant & name )

Returns the coordinate system name applied to the contour display.

Parameters

name	Name or index of the coordinate system

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

virtual

Specifies the result type.

Parameters

typeName	Result type name
sourceTitle	Title of the result calculation, such as FFT, when referencing a calclation tool.

Reimplemented in FluxLineDefinition, ContourDefinition, and VectorDefinition.

void ResultDefinition::SetScaleBarPosition	(	Variant &	leftPos,
		Variant &	topPos
	)

Specifies the scale bar position.

Parameters

leftPos	Position of the scale bar starting from the left
topPos	Position of the scale bar starting from the bottom

void ResultDefinition::SetScalingFactor ( Condition * cond )

Specifies Condition object for scaling.

Parameters

cond	Condition object

void ResultDefinition::SetTransparencyNonTarget ( bool on )

Specifies the transparency flag of non target parts.

Parameters

on	Transparency on/off

void ResultDefinition::SetTransparencyValueNonTarget ( Variant & value )

Specifies the transparency of non target parts.

Parameters

value Transparency(0~100)

void ResultDefinition::SetUseSpecifiedPosition ( bool useSpecifiedPosition )

Specifies whether or not to use the specified position of the scale bar.

Parameters

useSpecifiedPosition Flag for whether or not to use the specified position of the scale bar.

void ResultDefinition::SetViewIndex ( Variant & index )

Specifies the index of view setting.

Parameters

index Index of view setting

void ResultDefinition::SetViewName ( Variant & name )

Specifies the name of view setting.

Parameters

name	Name of the view setting

void ResultDefinition::SetViewOriginalModel ( bool on )

Specifies the display flag of original model.

Parameters

on	Display flag of original model

void ResultDefinition::SetViewPoint ( bool on )

Specifies the flag of view point.

Parameters

on	Flag of view point

void ResultDefinition::SetViewScale ( bool on )

Specifies the display flag of scaling.

Parameters

on	Display flag of scaling

Public Member Functions

Detailed Description

Member Function Documentation