FluxLineDefinition Class Reference

FluxLineDefinition class is used to specify flux lines.
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 parts list for rendering flux lines. More...
void	AddPoint (Point *position, String &name)
	Creates a start position for rendering. More...
void	AddPointWithUnit (Point *position, String &unitName, String &name)
	Adds a start position for the flux lines using a specified unit. More...
void	ClearCutPlanes ()
	Clears the setting of displayed cutting plane.
void	ClearPoints ()
	Deletes the entire start position for rendering.
String	DigitsNotationTypeName ()
	Returns type of numerical value display for the indicator on the scale bar. More...
void	ExportAllStepsFluxLines (String &dir, String &filename, double phase, int streamlineIndex, bool needsConverting)
	Exports the calculated flux lines of all calculated steps. More...
void	ExportAllStepsFluxLinesWithInterval (String &dir, String &filename, double phase, int streamlineIndex, bool needsConverting, double interval)
	Exports the calculated flux lines of all calculated steps. More...
void	ExportAllStepsLineIntegral (String &dir, String &filename, double phase)
	Exports the calculated flux lines' length and line integral. More...
void	ExportFluxLines (String &filename, int stepNum, double phase, int streamlineIndex, bool needsConverting)
	Exports the calculated flux lines. More...
void	ExportFluxLinesWithInterval (String &filename, int stepNum, double phase, int streamlineIndex, bool needsConverting, double interval)
	Exports the calculated flux lines with the interval set by the user. More...
void	ExportLineIntegral (String &filename, int stepNum, double phase)
	Exports the calculated flux lines' length and line integral. More...
bool	GetAutoScale ()
	Returns True as a return value if the automatic scale is set. More...
String	GetColor ()
	Returns the color of a line as a string. More...
StringList	GetCutPlaneList ()
	Returns the list of cutting plane index. More...
bool	GetDisplayScaleBar ()
	Returns True if user wants to display the scale bar. More...
int	GetDisplayType ()
	Returns the display type. More...
double	GetFluxValue ()
	Returns the amount of magnetic flux between flux lines. 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...
int	GetLines ()
	Returns the maximum number flux lines to render 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...
double	GetPlaneHeight ()
	Returns height of finite plane. More...
double	GetPlaneWidth ()
	Returns width of finite plane. More...
Point *	GetPoint (int index)
	Obtains coordinate value from the start position for rendering that is specified from the index. More...
String	GetPointName (int index)
	Returns then name of the start position for rendering that is specified from the index. More...
Point *	GetPointWithUnit (int index, String &unitName)
	Returns the position of the specified flux line start point with a specified unit. 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...
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	GetSeedLineAllParts ()
	Returns whether or not to render all parts. More...
bool	GetSmooth ()
	Returns True as a return value if smoothing is set. More...
double	GetThickness ()
	Returns the thickness of the line. 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	GetUseFinitePlane ()
	Returns whether or not to use the finite plane. 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	NumPoints ()
	Returns the number of start positions for rendering in flux lines. More...
int	Precision ()
	Returns the displayed digit that is after the decimal point. More...
void	RemoveAllParts ()
	Removes all parts from the parts list for rendering flux lines.
void	RenamePoint (int index, String &name)
	Changes name of the start position for specified index. More...
void	SetAutoScale (bool scale)
	Specifies the flag for the automatic scale. More...
void	SetColor (String &color)
	Specifies the color of the line. 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	SetDisplayType (int type)
	Specifies the display type. 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	SetFluxLineType (Variant var)
	Specifies the rendering type. More...
void	SetFluxValue (Variant &value)
	Specifies the amount of magnetic flux between flux lines. More...
void	SetGradient (String &name, Variant &levels, bool smooth)
	Specifies the argument to specify the color gradation. More...
void	SetLines (Variant &lines)
	Specifies the maximum number of flux lines to render. 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	SetNormal (Variant &x, Variant &y, Variant &z)
	Specifies a normal vector on the rendering plane. More...
void	SetNumLabels (Variant &labels)
	Specifies the number of labels in the scale bar. More...
void	SetOrigin (Variant &x, Variant &y, Variant &z)
	Specifies a point on the rendering plane. More...
void	SetPlaneHeight (Variant &height)
	Specifies height of finite plane. More...
void	SetPlaneWidth (Variant &width)
	Specifies width of the finite plane. More...
void	SetPoint (int index, Point *position)
	Creates start position for rendering with coordinate value and specified index. More...
void	SetPointWithUnit (int index, Point *position, String &unitName)
	Creates start position for rendering with coordinate value and specified index with a specified unit. 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...
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	SetSeedLineAllParts (bool use)
	Specifies whether or not all parts are an object of the rendering plane. More...
void	SetThickness (Variant &value)
	Specifies the thickness of the line. 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	SetUseFinitePlane (bool use)
	Specifies whether or not to use the finite plane. More...
void	SetUseFluxValue (bool useFluxValue)
	Specifies the display method for the flux line. 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

FluxLineDefinition class is used to specify flux lines.
The class can be called from Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetFluxLine(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 FluxLineDefinition::AddPart

(

int

partId

)

Adds new parts to the parts list for rendering flux lines.

Parameters

partId

Part ID

void FluxLineDefinition::AddPoint	(	Point *	position,
		String &	name
	)

Creates a start position for rendering.

Parameters

position	Point object (coordinate value of start position for rendering)
name	Name of the start position for rendering

void FluxLineDefinition::AddPointWithUnit	(	Point *	position,
		String &	unitName,
		String &	name
	)

Adds a start position for the flux lines using a specified unit.

Parameters

position	Point object (coordinate value of start position for rendering)
unitName	Unit
name	Name of the start position for rendering

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

void FluxLineDefinition::ExportAllStepsFluxLines	(	String &	dir,
		String &	filename,
		double	phase,
		int	streamlineIndex,
		bool	needsConverting
	)

Exports the calculated flux lines of all calculated steps.

Parameters

dir	Output folder
filename	Base file name for exporting csv file
phase	Current phase
streamlineIndex	Index of the flux line to be exported. 0 to export all flux lines.
needsConverting	Whether to convert the starting coordinate units to meters

void FluxLineDefinition::ExportAllStepsFluxLinesWithInterval	(	String &	dir,
		String &	filename,
		double	phase,
		int	streamlineIndex,
		bool	needsConverting,
		double	interval
	)

Exports the calculated flux lines of all calculated steps.

Parameters

dir	Output folder
filename	Base file name for exporting csv file
phase	Current phase
streamlineIndex	Index of the flux line to be exported. 0 to export all flux lines.
needsConverting	Whether to convert the starting coordinate units to meters
interval	Interval value for displaying the flux lines

void FluxLineDefinition::ExportAllStepsLineIntegral	(	String &	dir,
		String &	filename,
		double	phase
	)

Exports the calculated flux lines' length and line integral.

Parameters

dir	Output folder
filename	Base file name for exporting csv file
phase	Current phase.

void FluxLineDefinition::ExportFluxLines	(	String &	filename,
		int	stepNum,
		double	phase,
		int	streamlineIndex,
		bool	needsConverting
	)

Exports the calculated flux lines.

Parameters

filename	File name for exporting csv file
stepNum	Current step index
phase	Current phase
streamlineIndex	Index of the flux line to be exported. 0 to export all flux lines.
needsConverting	Whether to convert the starting coordinate units to meters

void FluxLineDefinition::ExportFluxLinesWithInterval	(	String &	filename,
		int	stepNum,
		double	phase,
		int	streamlineIndex,
		bool	needsConverting,
		double	interval
	)

Exports the calculated flux lines with the interval set by the user.

Parameters

filename	File name for exporting csv file
stepNum	Current step index
phase	Current phase
streamlineIndex	Index of the flux line to be exported. 0 to export all flux lines.
needsConverting	Whether to convert the starting coordinate units to meters
interval	Interval value for displaying the flux lines

void FluxLineDefinition::ExportLineIntegral	(	String &	filename,
		int	stepNum,
		double	phase
	)

Exports the calculated flux lines' length and line integral.

Parameters

filename	File name for exporting csv file
stepNum	Current step index
phase	Current phase

bool ResultDefinition::GetAutoScale ( )

inherited

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

Returns

Automatic ON/OFF status of scale

String FluxLineDefinition::GetColor

(

)

Returns the color of a line as a string.

Returns

Color of the line

StringList ResultDefinition::GetCutPlaneList ( )

inherited

Returns the list of cutting plane index.

Returns

List of cutting plane index

bool ResultDefinition::GetDisplayScaleBar ( )

inherited

Returns True if user wants to display the scale bar.

Returns

Whether or not to display the scale bar

int FluxLineDefinition::GetDisplayType

(

)

Returns the display type.

Returns

Display type

0 : Shaded
1 : Hidden Line
2 : Wireframe

double FluxLineDefinition::GetFluxValue

(

)

Returns the amount of magnetic flux between flux lines.

Returns

The amount of magnetic flux between lines (Wb)

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

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

int FluxLineDefinition::GetLines

(

)

Returns the maximum number flux lines to render as an integer.

Returns

Number of rendered lines

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

double FluxLineDefinition::GetPlaneHeight

(

)

Returns height of finite plane.

Returns

Height of finite plane

double FluxLineDefinition::GetPlaneWidth

(

)

Returns width of finite plane.

Returns

Width of finite plane

Point * FluxLineDefinition::GetPoint

(

int

index

)

Obtains coordinate value from the start position for rendering that is specified from the index.

Parameters

index

Index of the start position for rendering

Returns

Point object

String FluxLineDefinition::GetPointName

(

int

index

)

Returns then name of the start position for rendering that is specified from the index.

Parameters

index

Index of the start position for rendering

Returns

Name of the start point for rendering

Point * FluxLineDefinition::GetPointWithUnit	(	int	index,
		String &	unitName
	)

Returns the position of the specified flux line start point with a specified unit.

Parameters

index

Index of the start position for rendering

Returns

Point object

Parameters

unitName

Unit

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 FluxLineDefinition::GetResultType ( )

virtual

Returns the name of the result type as a string.

Returns

Name of the result type

Reimplemented from ResultDefinition.

Variant ResultDefinition::GetResultTypeNames ( )

inherited

Returns the list of the result types.

Returns

List of the result types

Condition * ResultDefinition::GetScalingFactor ( )

inherited

Returns the scaling condition is set.

Returns

Condition object

bool FluxLineDefinition::GetSeedLineAllParts

(

)

Returns whether or not to render all parts.

Returns

Whether or not to render all parts

True=1
False=0

bool ResultDefinition::GetSmooth ( )

inherited

Returns True as a return value if smoothing is set.

Returns

Smoothing ON/OFF

double FluxLineDefinition::GetThickness

(

)

Returns the thickness of the line.

Returns

Line thickness

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

bool FluxLineDefinition::GetUseFinitePlane

(

)

Returns whether or not to use the finite plane.

Returns

Whether or not to use the finite plane

True=1
False=0

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 FluxLineDefinition::NumPoints

(

)

Returns the number of start positions for rendering in flux lines.

Returns

Number of start position for rendering

int ResultDefinition::Precision ( )

inherited

Returns the displayed digit that is after the decimal point.

Returns

Display digit after the decimal point

void FluxLineDefinition::RenamePoint	(	int	index,
		String &	name
	)

Changes name of the start position for specified index.

Parameters

index	Index of the start position for rendering
name	Name

void ResultDefinition::SetAutoScale ( bool  scale )

inherited

Specifies the flag for the automatic scale.

Parameters

scale

ON/OFF

void FluxLineDefinition::SetColor

(

String &

color

)

Specifies the color of the line.

Parameters

color

Color of the line

The colors can be specified with the following methods.

• #RGB
  Hexadecimal digit for R, G, and B respectively
  
• #RRGGBB
  2 hexadecimal digits for R, G, and B
  
• Black, Red, etc.
  Predefined color names
  

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 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 FluxLineDefinition::SetDisplayType

(

int

type

)

Specifies the display type.

Parameters

type	0 : Shaded 1 : Hidden Line 2 : Wireframe

void FluxLineDefinition::SetFluxLineType

(

Variant

var

)

Specifies the rendering type.

Parameters

var	0=point : From point 1=plane : From plane

void FluxLineDefinition::SetFluxValue

(

Variant &

value

)

Specifies the amount of magnetic flux between flux lines.

Parameters

value

The amount of magnetic flux between lines (Wb).

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 FluxLineDefinition::SetLines

(

Variant &

lines

)

Specifies the maximum number of flux lines to render.

Parameters

lines

Number of lines

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 FluxLineDefinition::SetNormal	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a normal vector on the rendering plane.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void ResultDefinition::SetNumLabels ( Variant &  labels )

inherited

Specifies the number of labels in the scale bar.

Parameters

labels

Number of labels

void FluxLineDefinition::SetOrigin	(	Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a point on the rendering plane.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void FluxLineDefinition::SetPlaneHeight

(

Variant &

height

)

Specifies height of finite plane.

Parameters

height

Height of the finite plane

void FluxLineDefinition::SetPlaneWidth

(

Variant &

width

)

Specifies width of the finite plane.

Parameters

width

Width of the finite plane

void FluxLineDefinition::SetPoint	(	int	index,
		Point *	position
	)

Creates start position for rendering with coordinate value and specified index.

Parameters

index	Index of start position for rendering
position	Point object (coordinate value of start position for rendering)

void FluxLineDefinition::SetPointWithUnit	(	int	index,
		Point *	position,
		String &	unitName
	)

Creates start position for rendering with coordinate value and specified index with a specified unit.

Parameters

index	Index of start position for rendering
position	Point object (coordinate value of start position for rendering)
unitName	Unit

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 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 FluxLineDefinition::SetResultType ( String &  scriptName, 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 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 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 ResultDefinition::SetScalingFactor ( Condition *  cond )

inherited

Specifies Condition object for scaling.

Parameters

cond	Condition object

void FluxLineDefinition::SetSeedLineAllParts

(

bool

use

)

Specifies whether or not all parts are an object of the rendering plane.

Parameters

use	True=1 : [Seed Lines in All Parts] is enabled False=0 : [Seed Lines in All Parts] is disabled

void FluxLineDefinition::SetThickness

(

Variant &

value

)

Specifies the thickness of the line.

Parameters

value

Line thickness

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 FluxLineDefinition::SetUseFinitePlane

(

bool

use

)

Specifies whether or not to use the finite plane.

Parameters

use	True=1 : [Use Finite Plane] is enabled False=0 : [Use Finite Plane] is disabled

void FluxLineDefinition::SetUseFluxValue

(

bool

useFluxValue

)

Specifies the display method for the flux line.

Parameters

useFluxValue

False=0 : Number of Lines True=1 ： Fixed Flux

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