ContourDefinition class is used to specify contour plots.
The class can be called from Study class.
. More...

Inherits ResultDefinition.

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

void	AddPart (int partId)
	Adds new parts to the target list of rendering contours. 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...

String	GetComponent ()
	Returns the name of the component as a string. More...

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

String	GetContourType ()
	Returns display type of the contour a string. More...

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

bool	GetDisplayAllParts ()
	Returns whether or not to render contour for all parts. More...

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

bool	GetDisplayShellBeam ()
	Returns whether or not to display Shell/Beam. More...

bool	GetDivideElements ()
	Returns the flag to determine if quadriateral faces are subdivided. More...

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

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

bool	GetIsolines ()
	Returns True as a return value if an isoline is selected. 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...

int	GetReferenceStep ()
	Returns the step number of the reference step. This is used for a permanence calculation. 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...

String	GetResultUnit ()
	Returns the unit of the result. More...

bool	GetScaleByParts ()
	Returns a flag that indicates whether or not to define the scaling of the model from the minimum and maximum values. More...

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

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

double	GetTemperature ()
	Returns temperature. 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...

String	GetUserComponentType ()
	Returns the user component name in character string. 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	RemoveAllParts ()
	Removes all parts from target list of rendering contours.

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

void	SetComponent (String &name)
	Specifies the component of the result. More...

void	SetContourType (Variant &val)
	Switches the type of display contour (Shading, Isolines, Element). More...

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

void	SetDisplayAllParts (bool use)
	Specifies whether or not to set all parts to be rendered. More...

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

void	SetDisplayShellBeam (bool isChecked)
	Specifies whether or not to display Shell/Beam. More...

void	SetDivideElements (bool divideElements)
	Specifies whether or not to subdivide quadriateral faces. 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	SetHistoryAllSteps ()
	Specifies all steps to be referenced by the history function.

void	SetHistorySteps (String array &steps)
	Specifies the range of steps to be referenced by the history function. More...

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

void	SetIsolines (bool isoline)
	Specifies a flag for the isoline. 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	SetReferenceStep (Variant &step)
	Specifies the reference step number. This is used for a permanence calculation. 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 settings for result type. More...

void	SetResultUnit (String &name)
	Specifies the unit for the result. More...

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

void	SetScaleByParts (bool scaleByParts)
	Specifies whether or not to define the scaling of the model from the minimum and maximum values. More...

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

void	SetTemperature (Variant &value)
	Specifies temperature. 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	SetUserComponentType (String &name)
	Specifies a user component. 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

ContourDefinition class is used to specify contour plots.
The class can be called from Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetContour(0)

Member Function Documentation

void ResultDefinition::AddCutPlane ( Variant & index )

inherited

Specifies the index or name of cutting plane.

Parameters

index Index or name of cutting plane

void ContourDefinition::AddPart ( int partId )

Adds new parts to the target list of rendering contours.

Parameters

ID for parts

String ResultDefinition::DigitsNotationTypeName ( )

inherited

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 ( )

inherited

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

Returns: Automatic ON/OFF status of scale

String ContourDefinition::GetComponent ( )

Returns the name of the component as a string.

Returns: Component name

Variant ContourDefinition::GetComponentNames ( )

Returns a list of the components.

Returns: List of the component

String ContourDefinition::GetContourType ( )

Returns display type of the contour a string.

Returns: Display type of contour

Shading

Isoline

Element

StringList ResultDefinition::GetCutPlaneList ( )

inherited

Returns the list of cutting plane index.

Returns: List of cutting plane index

bool ContourDefinition::GetDisplayAllParts ( )

Returns whether or not to render contour for all parts.

Returns: Whether or not to render contour for all parts

bool ResultDefinition::GetDisplayScaleBar ( )

inherited

Returns True if user wants to display the scale bar.

Returns: Whether or not to display the scale bar

bool ContourDefinition::GetDisplayShellBeam ( )

Returns whether or not to display Shell/Beam.

Returns: Whether or not to display Shell/Beam

bool ContourDefinition::GetDivideElements ( )

Returns the flag to determine if quadriateral faces are subdivided.

Returns: Whether to divide or not

String ResultDefinition::GetGradientName ( )

inherited

Returns the name of the gradation type as a string.

Returns: Name of the gradation type

Variant ResultDefinition::GetGradientNames ( )

inherited

Returns the list of the gradation types.

Returns: List of the gradation types

bool ContourDefinition::GetIsolines ( )

Returns True as a return value if an isoline is selected.

Returns: Isoline ON/OFF

int ResultDefinition::GetLeftPosition ( )

inherited

Returns Left position specified by the user.

Returns: Left position specified by the user

int ResultDefinition::GetLevels ( )

inherited

Returns the number of color levels as an integer.

Returns: Number of color levels

bool ResultDefinition::GetLogScale ( )

inherited

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

Returns: Logarithmic scale ON/OFF

double ResultDefinition::GetMax ( )

inherited

Returns the maximum value as a real number.

Returns: Maximum value

double ResultDefinition::GetMin ( )

inherited

Returns the minimum value as a real number.

Returns: Minimum value

bool ResultDefinition::GetModelCopy ( )

inherited

Returns the display flag of model copy.

Returns: Display flag of model copy

String ResultDefinition::GetName ( )

inherited

Returns the name of the plot as a string.

Returns: Plot name

int ResultDefinition::GetNumLabels ( )

inherited

Returns the number of labels in the scale bar.

Returns: Number of labels in the scale bar

int ContourDefinition::GetReferenceStep ( )

Returns the step number of the reference step. This is used for a permanence calculation.

Returns: Step number

String ResultDefinition::GetResultCoordinateName ( )

inherited

Returns the coordinate system name applied to the contour display.

Returns: Name of the coordinate system

String ResultDefinition::GetResultCoordinateNameList ( )

inherited

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

Returns: List of the coordinate systems

String ResultDefinition::GetResultType ( )

virtualinherited

Returns the name of the result type as a string.

Returns: Name of the result type

Reimplemented in FluxLineDefinition.

Variant ResultDefinition::GetResultTypeNames ( )

inherited

Returns the list of the result types.

Returns: List of the result types

String ContourDefinition::GetResultUnit ( )

Returns the unit of the result.

Returns: Unit of result

bool ContourDefinition::GetScaleByParts ( )

Returns a flag that indicates whether or not to define the scaling of the model from the minimum and maximum values.

Returns: Whether or not to determine the scaling of the model from the minimum and maximum values

Condition * ResultDefinition::GetScalingFactor ( )

inherited

Returns the scaling condition is set.

Returns: Condition object

bool ResultDefinition::GetSmooth ( )

inherited

Returns True as a return value if smoothing is set.

Returns: Smoothing ON/OFF

double ContourDefinition::GetTemperature ( )

Returns temperature.

Returns: Temperature

This command is used when the demagnetization ratio (Compared to undemagnetized state, temperature dependent) is selected as the result type.

int ResultDefinition::GetTopPosition ( )

inherited

Returns Top position specified by the user.

Returns: Top position specified by the user

bool ResultDefinition::GetTransparencyNonTarget ( )

inherited

Returns the transparency flag of non target parts.

Returns: Transparency

int ResultDefinition::GetTransparencyValueNonTarget ( )

inherited

Returns the transparency of non target parts.

Returns: Transparency

String ContourDefinition::GetUserComponentType ( )

Returns the user component name in character string.

Returns: Name of the user component

bool ResultDefinition::GetUseSpecifiedPosition ( )

inherited

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 ( )

inherited

Returns the index of view setting.

Returns: Index of view setting

bool ResultDefinition::GetViewOriginalModel ( )

inherited

Returns the display flag of original model.

Returns: Display flag of original model

bool ResultDefinition::GetViewPoint ( )

inherited

Returns the view point flag.

Returns: View point flag

bool ResultDefinition::GetViewScale ( )

inherited

Returns the display flag of scaling.

Returns: Display flag of scaling

bool ResultDefinition::IsEditMode ( )

inherited

Returns whether it is in edit mode.

Returns: Whether in edit mode

bool ResultDefinition::IsValid ( )

inherited

Returns True if an object is valid.

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

int ResultDefinition::Precision ( )

inherited

Returns the displayed digit that is after the decimal point.

Returns: Display digit after the decimal point

void ResultDefinition::SetAutoScale ( bool scale )

inherited

Specifies the flag for the automatic scale.

Parameters

scale ON/OFF

void ContourDefinition::SetComponent ( String & name )

Specifies the component of the result.

Parameters

name	Component name

void ContourDefinition::SetContourType ( Variant & val )

Switches the type of display contour (Shading, Isolines, Element).

Parameters

val	Display type of contour Shading Isoline Element

void ResultDefinition::SetDigitsNotationType ( Variant & type )

inherited

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 ContourDefinition::SetDisplayAllParts ( bool use )

Specifies whether or not to set all parts to be rendered.

Parameters

use	True=1 : [Display on All Parts] is active False=0 : [Display on All Parts] is not active

void ResultDefinition::SetDisplayScaleBar ( bool displayScaleBar )

inherited

Specifies whether or not to display the scale bar.

Parameters

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

void ContourDefinition::SetDisplayShellBeam ( bool isChecked )

Specifies whether or not to display Shell/Beam.

Parameters

isChecked

True=1 : [Display Shell/Beam] is active

False=0 : [Display Shell/Beam] is not active

void ContourDefinition::SetDivideElements ( bool divideElements )

Specifies whether or not to subdivide quadriateral faces.

Parameters

divideElements

True=1 : Divide

False=0 : Do not divide

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

inherited

Specifies the argument to specify the color gradation.

Parameters

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

void ContourDefinition::SetHistorySteps ( String array & steps )

Specifies the range of steps to be referenced by the history function.

Parameters

steps Step

void ContourDefinition::SetHistoryStepsByString ( String & str )

Specifies multiple 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 a range (e.g. 4-8).

Parameters

str Step

void ContourDefinition::SetIsolines ( bool isoline )

Specifies a flag for the isoline.

Parameters

isoline

True=1 : Isoline

False=0 : Shading

void ResultDefinition::SetLogScale ( bool logscale )

inherited

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 )

inherited

Specifies the display flag of model copy.

Parameters

on	Display flag of model copy

void ResultDefinition::SetName ( String & name )

inherited

Specifies the name of the plot.

Parameters

name Plot name

void ResultDefinition::SetNumLabels ( Variant & labels )

inherited

Specifies the number of labels in the scale bar.

Parameters

labels Number of labels

void ResultDefinition::SetPrecision ( Variant & precision )

inherited

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
	)

inherited

Specifies the range between the minimum and maximum values.

Parameters

min	Minimum value
max	Maximum value

void ContourDefinition::SetReferenceStep ( Variant & step )

Specifies the reference step number. This is used for a permanence calculation.

Parameters

step	Step number

void ResultDefinition::SetResultCoordinate ( Variant & name )

inherited

Returns the coordinate system name applied to the contour display.

Parameters

name	Name or index of the coordinate system

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

virtual

Specifies settings for result type.

Parameters

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

sourceTitle can be omitted.
For information about the condition type name that can be specified as typeName , see Properties and Flags for Calculating Results .

Reimplemented from ResultDefinition.

void ContourDefinition::SetResultUnit ( String & name )

Specifies the unit for the result.

Parameters

name	Unit of result

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

inherited

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 ContourDefinition::SetScaleByParts ( bool scaleByParts )

Specifies whether or not to define the scaling of the model from the minimum and maximum values.

Parameters

scaleByParts

True=1 : Determine

False=0 : Do not determine

void ResultDefinition::SetScalingFactor ( Condition * cond )

inherited

Specifies Condition object for scaling.

Parameters

cond	Condition object

void ContourDefinition::SetTemperature ( Variant & value )

Specifies temperature.

Parameters

value Temperature

This command is used to display the demagnetization ratio (Compared to undemagnetized state, temperature dependent) for a magnetic field analysis.

void ResultDefinition::SetTransparencyNonTarget ( bool on )

inherited

Specifies the transparency flag of non target parts.

Parameters

on	Transparency on/off

void ResultDefinition::SetTransparencyValueNonTarget ( Variant & value )

inherited

Specifies the transparency of non target parts.

Parameters

value Transparency(0~100)

void ContourDefinition::SetUserComponentType ( String & name )

Specifies a user component.

Parameters

name	Name of the user component

void ResultDefinition::SetUseSpecifiedPosition ( bool useSpecifiedPosition )

inherited

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 )

inherited

Specifies the index of view setting.

Parameters

index Index of view setting

void ResultDefinition::SetViewName ( Variant & name )

inherited

Specifies the name of view setting.

Parameters

name	Name of the view setting

void ResultDefinition::SetViewOriginalModel ( bool on )

inherited

Specifies the display flag of original model.

Parameters

on	Display flag of original model

void ResultDefinition::SetViewPoint ( bool on )

inherited

Specifies the flag of view point.

Parameters

on	Flag of view point

void ResultDefinition::SetViewScale ( bool on )

inherited

Specifies the display flag of scaling.

Parameters

on	Display flag of scaling

Public Member Functions

Detailed Description

Member Function Documentation