ProbeDefinition class is used to verify the results at any position using a probe on the model.
The class can be called from Study class.
. More...

Public Member Functions
void	AddId (int id, String &name)
	Adds a measuring position of a specified ID. More...

void	AddLocation (Variant &x, Variant &y, Variant &z, String &name)
	Adds a measuring position of specified coordinates. More...

void	AddPoint (Point *position, String &name)
	Adds a measuring position of a specified coordinate. More...

void	AddPointWithUnit (Point *position, String &unitName, String &name)
	Adds a measuring position of a specified coordinate with a specified unit. More...

void	Build ()
	Updates data.

void	ClearPoints ()
	Removes all measuring positions.

void	ExportPoints (String &filename)
	Exports the measuring positions to a CSV file. More...

bool	GetAutoRecalculate ()
	Returns the value of the flag to automatically update data. More...

DataSet *	GetCaseDataSet (int caseno)
	Returns a DataSet object for the specified case. More...

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

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

DataSet *	GetDataSet ()
	Returns a list of the components. More...

String	GetLocationCoordinateName ()
	Returns name of the evaluation coordinate system applied to a measuring position. More...

bool	GetMoveWithPart ()
	Returns True as the return value when the probes are moved with measurement target. More...

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

double	GetPhase ()
	Returns a phase. More...

String	GetPhaseType ()
	Returns display format. More...

Point *	GetPoint (int index)
	Returns the coordinate value of a measuring position specified by index. More...

String	GetPointName (int index)
	Returns the name of the measuring position specified by index. More...

Point *	GetPointWithUnit (int index, String &unitName)
	Returns the postition of the specified calculation point. More...

int	GetPositionId (int index)
	Specifies an index of a measuring position to an obtain element ID or node ID. More...

String	GetProbeType ()
	Returns the type of method used to specify each measuring position of a probe as a string. More...

StringList	GetProbeTypeNames ()
	Returns the type of method used to specify each measuring position of a probe in a list. More...

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

String	GetResultCoordinateName ()
	Returns the name of the reference coordinate system applied to a probe. More...

String	GetResultCoordinateNameList ()
	Returns list of coordinate systems that can be applied to a probe. More...

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

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

double	GetTemperature ()
	Returns temperature. More...

bool	GetUseElementValue ()
	Returns True as a return value when using the element value. More...

String	GetUserComponentType ()
	Returns the user component name as a character string. More...

void	ImportPoints (String &filename)
	Imports the measuring positions from a CSV file. More...

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

int	NumPoints ()
	Returns the number of measurement points. More...

void	RemovePoint (int index)
	Deletes a measuring position by specifying the index. More...

void	RenamePoint (int index, String &name)
	Changes the name of the measuring position specified by index. More...

void	SetAutoRecalculate (bool flag)
	Specifies the flag to automatically update the data when the definition is updated. More...

void	SetComponent (String &name)
	Specifies the component of the result. 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 the steps to be referenced by the history function using a string. More...

void	SetId (int index, int id)
	Specifies the index of a measuring position to specify an element ID or node ID. More...

void	SetLocation (int index, Variant &x, Variant &y, Variant &z)
	Specifies a location for the probe as separate x,y,z coordinates. More...

void	SetLocationCoordinate (Variant &name)
	Applies the evaluation coordinate system to a measuring position by specifying a name or index. More...

void	SetMoveWithPart (bool value)
	Specifies the flag to move the probes with a measurement target. More...

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

void	SetPhase (double value)
	Specifies a phase. More...

void	SetPhaseType (Variant &value)
	Specifies the display type. More...

void	SetPoint (int index, Point *position)
	Adds a measuring position for the specified coordinate. More...

void	SetPointWithUnit (int index, Point *position, String &unitName)
	Adds a measuring position of a specified coordinate with a specified unit. More...

void	SetProbeType (Variant &name)
	Specifies the type of method used to specify each measuring position of a probe. More...

void	SetReferenceStep (Variant &step)
	Specifies the reference step. More...

void	SetResultCoordinate (Variant &name)
	Applies the reference coordinate system to a probe by specifying a name or index. More...

void	SetResultType (String &ytpeName, String &sourceTitle=String())
	Specifies the result type using the name. More...

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

void	SetUseElementValue (bool use)
	Specifies a flag for using the element value. More...

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

Detailed Description

ProbeDefinition class is used to verify the results at any position using a probe on the model.
The class can be called from Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetProbe(0)

The reference coordinate system is a coordinate system applied to component results.
The evaluation coordinate system is a coordinate system applied to the coordinate values of measuring positions.

Member Function Documentation

void ProbeDefinition::AddId	(	int	id,
		String &	name
	)

Adds a measuring position of a specified ID.

Parameters

id	Element ID or Node ID
name	Measuring position name

void ProbeDefinition::AddLocation	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	name
	)

Adds a measuring position of specified coordinates.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate
name	Name of the measuring position

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

Adds a measuring position of a specified coordinate.

Parameters

position	Point object (coordinate of the measurement)
name	Name of the measuring position

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

Adds a measuring position of a specified coordinate with a specified unit.

Parameters

position	Point object (coordinate value of the measuring position)
unitName	Unit
name	Name of the measuring position

void ProbeDefinition::ExportPoints ( String & filename )

Exports the measuring positions to a CSV file.

Parameters

filename Path of the file to export

bool ProbeDefinition::GetAutoRecalculate ( )

Returns the value of the flag to automatically update data.

Returns: Whether or not to update data automatically

DataSet * ProbeDefinition::GetCaseDataSet ( int caseno )

Returns a DataSet object for the specified case.

Parameters

caseno Case number

Returns: DataSet object

The "caseno" parameter is the one-based number.

String ProbeDefinition::GetComponent ( )

Returns the name of the component as a string.

Returns: Component name

Variant ProbeDefinition::GetComponentNames ( )

Returns a list of the components.

Returns: List of the components

DataSet * ProbeDefinition::GetDataSet ( )

Returns a list of the components.

Returns: DataSet object

String ProbeDefinition::GetLocationCoordinateName ( )

Returns name of the evaluation coordinate system applied to a measuring position.

Returns: Name of the evaluation coordinate system

bool ProbeDefinition::GetMoveWithPart ( )

Returns True as the return value when the probes are moved with measurement target.

Returns: Whether or not to move with a measurement target.

String ProbeDefinition::GetName ( )

Returns the name of the probe as a string.

Returns: Probe name

double ProbeDefinition::GetPhase ( )

Returns a phase.

Some of the output items can be obtained for a magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis.

Returns: Phase

String ProbeDefinition::GetPhaseType ( )

Returns display format.

Some of the output items can be obtained for a magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis.

Returns: Phase type

"RealImag" = Displays real part and imaginary part

"AmplitudePhase" = Displays amplitude and phase

"FixedPhase" = Specified phase

Point * ProbeDefinition::GetPoint ( int index )

Returns the coordinate value of a measuring position specified by index.

Parameters

index Index of the measuring position (start from 0)

Returns: Point object

String ProbeDefinition::GetPointName ( int index )

Returns the name of the measuring position specified by index.

Parameters

index Index of the measuring position (start from 0)

Returns: Name of the measuring position

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

Returns the postition of the specified calculation point.

Parameters

index	Index of the measuring position (start from 0)
unitName	Unit

Returns: Point object

int ProbeDefinition::GetPositionId ( int index )

Specifies an index of a measuring position to an obtain element ID or node ID.

Parameters

index Index of the measuring position (start from 0)

Returns: Element ID or Node ID

String ProbeDefinition::GetProbeType ( )

Returns the type of method used to specify each measuring position of a probe as a string.

Returns: "Coordinate" = Specifies coordinates

"Id" = Specifies ID

StringList ProbeDefinition::GetProbeTypeNames ( )

Returns the type of method used to specify each measuring position of a probe in a list.

Returns: List of names for probe type

int ProbeDefinition::GetReferenceStep ( )

Returns the reference step.

Returns: Reference step ID

This command is used when the demagnetization ratio (Compared to reference step) is selected as the result type.

String ProbeDefinition::GetResultCoordinateName ( )

Returns the name of the reference coordinate system applied to a probe.

Returns: Name of the reference coordinate system

String ProbeDefinition::GetResultCoordinateNameList ( )

Returns list of coordinate systems that can be applied to a probe.

Returns: List of coordinate system names

String ProbeDefinition::GetResultType ( )

Returns the name of the result type as a string.

Returns: Name of the result type

Variant ProbeDefinition::GetResultTypeNames ( )

Returns a list of the result types.

Returns: List of the result types

double ProbeDefinition::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.

bool ProbeDefinition::GetUseElementValue ( )

Returns True as a return value when using the element value.

Returns: Whether or not to use the element value

String ProbeDefinition::GetUserComponentType ( )

Returns the user component name as a character string.

Returns: Name of the user component

void ProbeDefinition::ImportPoints ( String & filename )

Imports the measuring positions from a CSV file.

Parameters

filename Path of the file to import

bool ProbeDefinition::IsValid ( )

Returns True if an object is valid.

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

int ProbeDefinition::NumPoints ( )

Returns the number of measurement points.

Returns: Number of measurement points

void ProbeDefinition::RemovePoint ( int index )

Deletes a measuring position by specifying the index.

Parameters

index Index of the measuring position (start from 0)

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

Changes the name of the measuring position specified by index.

Parameters

index	Index of the measuring position (start from 0)
name	Name of the measuring position

void ProbeDefinition::SetAutoRecalculate ( bool flag )

Specifies the flag to automatically update the data when the definition is updated.

Parameters

flag	True=1 : Recalculates automatically False=0 : Does not recalculate automatically

void ProbeDefinition::SetComponent ( String & name )

Specifies the component of the result.

Parameters

name	Component name

void ProbeDefinition::SetHistorySteps ( String array & steps )

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

Parameters

steps Step number

void ProbeDefinition::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

void ProbeDefinition::SetId	(	int	index,
		int	id
	)

Specifies the index of a measuring position to specify an element ID or node ID.

Parameters

index	Index of the measuring position (start from 0)
id	Element ID or Node ID

void ProbeDefinition::SetLocation	(	int	index,
		Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies a location for the probe as separate x,y,z coordinates.

Parameters

index	Index of the measuring position
x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void ProbeDefinition::SetLocationCoordinate ( Variant & name )

Applies the evaluation coordinate system to a measuring position by specifying a name or index.

Parameters

name	Name or index of the coordinate system

void ProbeDefinition::SetMoveWithPart ( bool value )

Specifies the flag to move the probes with a measurement target.

Parameters

value

True=1 : Moves with a measurement target

False=0 : Does not move with a measurement target

void ProbeDefinition::SetName ( String & name )

Specifies the name of the probe.

Parameters

name	Probe name

void ProbeDefinition::SetPhase ( double value )

Specifies a phase.

Some of the output items can be obtained for a magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis.

Parameters

value Phase

void ProbeDefinition::SetPhaseType ( Variant & value )

Specifies the display type.

Some of the output items can be obtained for a magnetic field frequency analysis, structural eigenmode analysis, structural frequency analysis, and electric field frequency analysis.

Parameters

value

Display type

"RealImag" or "0" = Displays real part and imaginary part
"AmplitudePhase" or "1" = Displays amplitude and phase
"FixedPhase" or "2" = Specified phase

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

Adds a measuring position for the specified coordinate.

Parameters

index	Index of the measuring position
position	Point object (coordinate value of the measuring position)

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

Adds a measuring position of a specified coordinate with a specified unit.

Parameters

index	Index of the measuring position
position	Point object (coordinate of the measurement)
unitName	Unit

void ProbeDefinition::SetProbeType ( Variant & name )

Specifies the type of method used to specify each measuring position of a probe.

Parameters

name	"Coordinate" or 0 : Specifies coordinates "Id" or 1 : Specifies Id

void ProbeDefinition::SetReferenceStep ( Variant & step )

Specifies the reference step.

Parameters

step	Reference step ID

This command is used to display the demagnetization ratio (Compared to reference step) for a magnetic field analysis.

void ProbeDefinition::SetResultCoordinate ( Variant & name )

Applies the reference coordinate system to a probe by specifying a name or index.

Parameters

name	Name or index of the coordinate system

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

Specifies the result type using the name.

Parameters

typeName	Result type name
sourceTitle	Title, such as "FFT calculation"

sourceTitle can be omitted.

For information about the names of condition types that can be specified as typeName, see Properties for the Physical Quantity Display .

void ProbeDefinition::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 ProbeDefinition::SetUseElementValue ( bool use )

Specifies a flag for using the element value.

Parameters

use	True=1 : Uses the element value False=0 : Does not use the element value

void ProbeDefinition::SetUserComponentType ( String & name )

Specifies the user component.

Parameters

name	Name of the user component

Public Member Functions

Detailed Description

Member Function Documentation