Public Member Functions | List of all members
CalculationTarget Class Reference

CalculationTarget class Used to create arbitrary cross section / edges and perform calculation processing.
The class can be obtained from Study class. More...

Public Member Functions

String GetAxialDirectionType ()
 Returns the mapping plane when specifying cylindrical coordinate system in section. More...
 
String GetCoordinateName ()
 Returns the name of the coordinate system being used. More...
 
String GetCoordinateNameList ()
 Returns a list of coordinate systems that can be used. More...
 
String GetEvaluationType ()
 Returns the specified method of evaluation location. More...
 
bool GetFollowReference ()
 Returns whether or not to move the evaluation location together with the moving part when designating the reference edge or ID. More...
 
String GetName ()
 Returns a title. More...
 
PointGetOffset ()
 Returns the offset value. More...
 
Variant GetRadius ()
 Returns the radius when specifying cylindrical coordinate system in section. More...
 
int GetReferenceId ()
 Returns the edge or face ID to be referenced. More...
 
Variant GetReferenceRadius ()
 Returns the radius when specifying the reference plane. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
void SetAxialDirectionType (String &type)
 Specifies the mapping surface when specifying cylindrical coordinate system in section. More...
 
void SetCoordinate (Variant &name)
 Specifies coordinate system to be used by specifying its name or index. More...
 
void SetEvaluationType (String &type)
 Specifies how to specify the evaluation location. More...
 
void SetFollowReference (bool follow)
 Specifies whether to move the evaluation location together with the moving part when specifying the reference edge or ID. More...
 
void SetName (String &name)
 Specifies a title. More...
 
void SetOffset (Variant &x, Variant &y, Variant &z)
 Specifies the offset value. More...
 
void SetRadius (Variant &value)
 Specifies the radius when designating cylindrical coordinate system in section. More...
 
void SetReferenceId (int value)
 Specifies the edge or face ID to be referenced. More...
 
void SetReferenceRadius (Variant &value)
 Specifies the radius when specifying the reference plane. More...
 
void SetTable (String array &table)
 Specifies the coordinates of the evaluation location. More...
 

Detailed Description

CalculationTarget class Used to create arbitrary cross section / edges and perform calculation processing.
The class can be obtained from Study class.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCalculationTarget(0)

Member Function Documentation

String CalculationTarget::GetAxialDirectionType ( )

Returns the mapping plane when specifying cylindrical coordinate system in section.

Returns
String
Mapping surface
RDirection : R
ZDirection : Z
String CalculationTarget::GetCoordinateName ( )

Returns the name of the coordinate system being used.

Returns
Name of the coordinate system
String CalculationTarget::GetCoordinateNameList ( )

Returns a list of coordinate systems that can be used.

Returns
List of names for coordinate systems
String CalculationTarget::GetEvaluationType ( )

Returns the specified method of evaluation location.

Returns
String
Location specification
Coordinate : Specify coordinate system
Reference : Reference edge or face
bool CalculationTarget::GetFollowReference ( )

Returns whether or not to move the evaluation location together with the moving part when designating the reference edge or ID.

Returns
Move the evaluation part with the moving part On / Off
String CalculationTarget::GetName ( )

Returns a title.

Returns
String
Point * CalculationTarget::GetOffset ( )

Returns the offset value.

Returns
Point object
Variant CalculationTarget::GetRadius ( )

Returns the radius when specifying cylindrical coordinate system in section.

Returns
Radius
int CalculationTarget::GetReferenceId ( )

Returns the edge or face ID to be referenced.

Returns
Edge or face ID
Variant CalculationTarget::GetReferenceRadius ( )

Returns the radius when specifying the reference plane.

Returns
Radius
bool CalculationTarget::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the CalculationTarget objects in the list are valid
void CalculationTarget::SetAxialDirectionType ( String &  type)

Specifies the mapping surface when specifying cylindrical coordinate system in section.

Parameters
type
Mapping surface
RDirection : R
ZDirection : Z
void CalculationTarget::SetCoordinate ( Variant &  name)

Specifies coordinate system to be used by specifying its name or index.

Parameters
nameName or index of the coordinate system
void CalculationTarget::SetEvaluationType ( String &  type)

Specifies how to specify the evaluation location.

Parameters
type
Location specification
Coordinate : Specify coordinate system
Reference : Reference edge or face
void CalculationTarget::SetFollowReference ( bool  follow)

Specifies whether to move the evaluation location together with the moving part when specifying the reference edge or ID.

Parameters
follow
Flag for moving the evaluation location together with the moving part
True : Moves
False : Does not move
void CalculationTarget::SetName ( String &  name)

Specifies a title.

Parameters
nameName
void CalculationTarget::SetOffset ( Variant &  x,
Variant &  y,
Variant &  z 
)

Specifies the offset value.

Parameters
xOffset amount of x coordinate
yOffset amount of y coordinate
zunused
void CalculationTarget::SetRadius ( Variant &  value)

Specifies the radius when designating cylindrical coordinate system in section.

Parameters
valueRadius
void CalculationTarget::SetReferenceId ( int  value)

Specifies the edge or face ID to be referenced.

Parameters
valueEdge or face ID
void CalculationTarget::SetReferenceRadius ( Variant &  value)

Specifies the radius when specifying the reference plane.

Parameters
valueRadius
void CalculationTarget::SetTable ( String array &  table)

Specifies the coordinates of the evaluation location.

Parameters
matMultidimensional array