NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::ElementTranslateBuilder Class Reference

Represents a NXOpen::CAE::ElementTranslateBuilder
To create a new instance of this class, use NXOpen::CAE::NodeElementManager::CreateElementTranslateBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAE::ElementTranslateBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CopyType { CopyTypeTranslateOnly, CopyTypeCopyTranslate, CopyTypeElementCoat }
 the copy types More...
 
enum  DistanceType { DistanceTypePerCopy, DistanceTypeTotal }
 Distance - specify whether the translation distance is per copy or total. More...
 
enum  ElemDimensionType { ElemDimensionTypeAny, ElemDimensionTypeBeam, ElemDimensionTypeShell, ElemDimensionTypeSolid }
 Dimension of the elements to be created. More...
 
enum  LabelType { LabelTypeLabel, LabelTypeOffset }
 Option to use label/increment or offset. More...
 
enum  MethodType { MethodTypeComponent, MethodTypeDirection, MethodTypeElemNormal, MethodTypePointToPoint }
 Translation method. More...
 
enum  NewMeshType { NewMeshTypeCreate, NewMeshTypeExisting }
 Option to create a new mesh or add the new elements to an existing mesh. More...
 

Public Member Functions

NXOpen::CAE::ElementTranslateBuilder::CopyType CopyOption ()
 Returns the copy option . More...
 
NXOpen::CoordinateSystemCsys ()
 Returns the coordinate system to be used for translating the selected elements
Created in NX5.0.0. More...
 
NXOpen::ExpressionDistance ()
 Returns the total distance for translation along a vector
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTranslateBuilder::DistanceType DistanceOption ()
 Returns the distance option
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTranslateBuilder::ElemDimensionType ElementDimension ()
 Returns the dimension of the elements to be translated
Created in NX5.0.0. More...
 
NXOpen::CAE::SelectElementsBuilderElementSelection ()
 Returns the selected elements
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTypeBuilderElementType ()
 Returns the element type builder. More...
 
bool ExportMesh ()
 Returns the option which indicates whether mesh is exported to solver or not. More...
 
int FlipState ()
 Returns the flip state from the builder
Created in NX8.0.0. More...
 
int Increment ()
 Returns the increment in label for each new element
Created in NX5.0.0. More...
 
int Label ()
 Returns the start label for the new elements
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTranslateBuilder::LabelType LabelOption ()
 Returns the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels
Created in NX5.0.0. More...
 
NXString MeshCollectorName ()
 Returns the name of the mesh collector which will hold the new elements
Created in NX5.0.0. More...
 
NXString MeshName ()
 Returns the name of the mesh that will hold the new elements
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTranslateBuilder::MethodType Method ()
 Returns the method to be used for translating the selected elements
Created in NX5.0.0. More...
 
NXString NeutralName ()
 Returns the neutral name of the elements to be created
Created in NX5.0.0. More...
 
NXOpen::CAE::ElementTranslateBuilder::NewMeshType NewMeshOption ()
 Returns the option to create a new mesh or add the new elements to an existing mesh
Created in NX5.0.0. More...
 
int NumCopy ()
 Returns the number of copies to be created for each selected element
Created in NX5.0.0. More...
 
int Offset ()
 Returns the offset to be used to generate new element labels
Created in NX5.0.0. More...
 
NXOpen::ExpressionPAngle ()
 Returns the phi angle for translation in a spherical coordinate system
Created in NX5.0.0. More...
 
NXOpen::ExpressionRDistance ()
 Returns the radial component of distance for translation in a cylindrical/spherical coordinate system
Created in NX5.0.0. More...
 
void SetCopyOption (NXOpen::CAE::ElementTranslateBuilder::CopyType inCopyoption)
 Sets the copy option . More...
 
void SetCsys (NXOpen::CoordinateSystem *csys)
 Sets the coordinate system to be used for translating the selected elements
Created in NX5.0.0. More...
 
void SetDistanceOption (NXOpen::CAE::ElementTranslateBuilder::DistanceType distanceOption)
 Sets the distance option
Created in NX5.0.0. More...
 
void SetElementDimension (NXOpen::CAE::ElementTranslateBuilder::ElemDimensionType elementDimension)
 Sets the dimension of the elements to be translated
Created in NX5.0.0. More...
 
void SetExportMesh (bool fExportMesh)
 Sets the option which indicates whether mesh is exported to solver or not. More...
 
void SetFlipState (int flipstate)
 Sets the flip state from the builder
Created in NX8.0.0. More...
 
void SetIncrement (int increment)
 Sets the increment in label for each new element
Created in NX5.0.0. More...
 
void SetLabel (int label)
 Sets the start label for the new elements
Created in NX5.0.0. More...
 
void SetLabelOption (NXOpen::CAE::ElementTranslateBuilder::LabelType labelOption)
 Sets the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels
Created in NX5.0.0. More...
 
void SetMeshCollectorName (const NXString &meshCollectorName)
 Sets the name of the mesh collector which will hold the new elements
Created in NX5.0.0. More...
 
void SetMeshCollectorName (const char *meshCollectorName)
 Sets the name of the mesh collector which will hold the new elements
Created in NX5.0.0. More...
 
void SetMeshName (const NXString &meshName)
 Sets the name of the mesh that will hold the new elements
Created in NX5.0.0. More...
 
void SetMeshName (const char *meshName)
 Sets the name of the mesh that will hold the new elements
Created in NX5.0.0. More...
 
void SetMethod (NXOpen::CAE::ElementTranslateBuilder::MethodType method)
 Sets the method to be used for translating the selected elements
Created in NX5.0.0. More...
 
void SetNeutralName (const NXString &neutralName)
 Sets the neutral name of the elements to be created
Created in NX5.0.0. More...
 
void SetNeutralName (const char *neutralName)
 Sets the neutral name of the elements to be created
Created in NX5.0.0. More...
 
void SetNewMeshOption (NXOpen::CAE::ElementTranslateBuilder::NewMeshType newMeshOption)
 Sets the option to create a new mesh or add the new elements to an existing mesh
Created in NX5.0.0. More...
 
void SetNumCopy (int numCopy)
 Sets the number of copies to be created for each selected element
Created in NX5.0.0. More...
 
void SetOffset (int offset)
 Sets the offset to be used to generate new element labels
Created in NX5.0.0. More...
 
void SetSourcePoint (NXOpen::Point *sourcePoint)
 Sets the source point . More...
 
void SetTargetPoint (NXOpen::Point *targetPoint)
 Sets the target point . More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the vector along which the selected elements should be translated
Created in NX5.0.0. More...
 
NXOpen::PointSourcePoint ()
 Returns the source point . More...
 
NXOpen::ExpressionTAngle ()
 Returns the theta angle for translation in a cylindrical/spherical coordinate system
Created in NX5.0.0. More...
 
NXOpen::PointTargetPoint ()
 Returns the target point . More...
 
NXOpen::DirectionVector ()
 Returns the vector along which the selected elements should be translated
Created in NX5.0.0. More...
 
NXOpen::ExpressionXDistance ()
 Returns the x component of distance for translation in a cartesian coordinate system
Created in NX5.0.0. More...
 
NXOpen::ExpressionYDistance ()
 Returns the y component of distance for translation in a cartesian coordinate system
Created in NX5.0.0. More...
 
NXOpen::ExpressionZDistance ()
 Returns the z component of distance for translation in a cartesian/cylindrical coordinate system
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::ElementTranslateBuilder
To create a new instance of this class, use NXOpen::CAE::NodeElementManager::CreateElementTranslateBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the copy types

Enumerator
CopyTypeTranslateOnly 

translate without copying elements

CopyTypeCopyTranslate 

first copy elements then translate the copies

CopyTypeElementCoat 

make 1D element using the existing nodes

Distance - specify whether the translation distance is per copy or total.

Enumerator
DistanceTypePerCopy 

distance specified is for each copy

DistanceTypeTotal 

distance specified is total translation distance

Dimension of the elements to be created.

Enumerator
ElemDimensionTypeAny 

any element can be selected

ElemDimensionTypeBeam 

only beam elements can be selected

ElemDimensionTypeShell 

only shell elements can be selected

ElemDimensionTypeSolid 

only solid elements can be selected

Option to use label/increment or offset.

Enumerator
LabelTypeLabel 

specify start label and increment for new elements

LabelTypeOffset 

offset labels of selected element to get new labels

Translation method.

Enumerator
MethodTypeComponent 

translate by components

MethodTypeDirection 

translate along a vector

MethodTypeElemNormal 

translate along element normal

MethodTypePointToPoint 

translate by point to point

Option to create a new mesh or add the new elements to an existing mesh.

Enumerator
NewMeshTypeCreate 

create a new mesh

NewMeshTypeExisting 

add new elements to an existing mesh

Member Function Documentation

NXOpen::CAE::ElementTranslateBuilder::CopyType NXOpen::CAE::ElementTranslateBuilder::CopyOption ( )

Returns the copy option .


Created in NX12.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::CAE::ElementTranslateBuilder::Csys ( )

Returns the coordinate system to be used for translating the selected elements
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::Distance ( )

Returns the total distance for translation along a vector
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTranslateBuilder::DistanceType NXOpen::CAE::ElementTranslateBuilder::DistanceOption ( )

Returns the distance option
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTranslateBuilder::ElemDimensionType NXOpen::CAE::ElementTranslateBuilder::ElementDimension ( )

Returns the dimension of the elements to be translated
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::SelectElementsBuilder* NXOpen::CAE::ElementTranslateBuilder::ElementSelection ( )

Returns the selected elements
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTypeBuilder* NXOpen::CAE::ElementTranslateBuilder::ElementType ( )

Returns the element type builder.


Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

bool NXOpen::CAE::ElementTranslateBuilder::ExportMesh ( )

Returns the option which indicates whether mesh is exported to solver or not.


Created in NX10.0.0.

License requirements : None

int NXOpen::CAE::ElementTranslateBuilder::FlipState ( )

Returns the flip state from the builder
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

int NXOpen::CAE::ElementTranslateBuilder::Increment ( )

Returns the increment in label for each new element
Created in NX5.0.0.



License requirements : None

int NXOpen::CAE::ElementTranslateBuilder::Label ( )

Returns the start label for the new elements
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTranslateBuilder::LabelType NXOpen::CAE::ElementTranslateBuilder::LabelOption ( )

Returns the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAE::ElementTranslateBuilder::MeshCollectorName ( )

Returns the name of the mesh collector which will hold the new elements
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAE::ElementTranslateBuilder::MeshName ( )

Returns the name of the mesh that will hold the new elements
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTranslateBuilder::MethodType NXOpen::CAE::ElementTranslateBuilder::Method ( )

Returns the method to be used for translating the selected elements
Created in NX5.0.0.



License requirements : None

NXString NXOpen::CAE::ElementTranslateBuilder::NeutralName ( )

Returns the neutral name of the elements to be created
Created in NX5.0.0.



License requirements : None

NXOpen::CAE::ElementTranslateBuilder::NewMeshType NXOpen::CAE::ElementTranslateBuilder::NewMeshOption ( )

Returns the option to create a new mesh or add the new elements to an existing mesh
Created in NX5.0.0.



License requirements : None

int NXOpen::CAE::ElementTranslateBuilder::NumCopy ( )

Returns the number of copies to be created for each selected element
Created in NX5.0.0.



License requirements : None

int NXOpen::CAE::ElementTranslateBuilder::Offset ( )

Returns the offset to be used to generate new element labels
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::PAngle ( )

Returns the phi angle for translation in a spherical coordinate system
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::RDistance ( )

Returns the radial component of distance for translation in a cylindrical/spherical coordinate system
Created in NX5.0.0.



License requirements : None

void NXOpen::CAE::ElementTranslateBuilder::SetCopyOption ( NXOpen::CAE::ElementTranslateBuilder::CopyType  inCopyoption)

Sets the copy option .


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
inCopyoptionincopyoption
void NXOpen::CAE::ElementTranslateBuilder::SetCsys ( NXOpen::CoordinateSystem csys)

Sets the coordinate system to be used for translating the selected elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
csyscsys
void NXOpen::CAE::ElementTranslateBuilder::SetDistanceOption ( NXOpen::CAE::ElementTranslateBuilder::DistanceType  distanceOption)

Sets the distance option
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
distanceOptiondistance option
void NXOpen::CAE::ElementTranslateBuilder::SetElementDimension ( NXOpen::CAE::ElementTranslateBuilder::ElemDimensionType  elementDimension)

Sets the dimension of the elements to be translated
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
elementDimensionelement dimension
void NXOpen::CAE::ElementTranslateBuilder::SetExportMesh ( bool  fExportMesh)

Sets the option which indicates whether mesh is exported to solver or not.


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
fExportMeshfexportmesh
void NXOpen::CAE::ElementTranslateBuilder::SetFlipState ( int  flipstate)

Sets the flip state from the builder
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
flipstateflipstate
void NXOpen::CAE::ElementTranslateBuilder::SetIncrement ( int  increment)

Sets the increment in label for each new element
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
incrementincrement
void NXOpen::CAE::ElementTranslateBuilder::SetLabel ( int  label)

Sets the start label for the new elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
labellabel
void NXOpen::CAE::ElementTranslateBuilder::SetLabelOption ( NXOpen::CAE::ElementTranslateBuilder::LabelType  labelOption)

Sets the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
labelOptionlabel option
void NXOpen::CAE::ElementTranslateBuilder::SetMeshCollectorName ( const NXString meshCollectorName)

Sets the name of the mesh collector which will hold the new elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
meshCollectorNamemesh collector name
void NXOpen::CAE::ElementTranslateBuilder::SetMeshCollectorName ( const char *  meshCollectorName)

Sets the name of the mesh collector which will hold the new elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
meshCollectorNamemesh collector name
void NXOpen::CAE::ElementTranslateBuilder::SetMeshName ( const NXString meshName)

Sets the name of the mesh that will hold the new elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
meshNamemesh name
void NXOpen::CAE::ElementTranslateBuilder::SetMeshName ( const char *  meshName)

Sets the name of the mesh that will hold the new elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
meshNamemesh name
void NXOpen::CAE::ElementTranslateBuilder::SetMethod ( NXOpen::CAE::ElementTranslateBuilder::MethodType  method)

Sets the method to be used for translating the selected elements
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
methodmethod
void NXOpen::CAE::ElementTranslateBuilder::SetNeutralName ( const NXString neutralName)

Sets the neutral name of the elements to be created
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
neutralNameneutral name
void NXOpen::CAE::ElementTranslateBuilder::SetNeutralName ( const char *  neutralName)

Sets the neutral name of the elements to be created
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
neutralNameneutral name
void NXOpen::CAE::ElementTranslateBuilder::SetNewMeshOption ( NXOpen::CAE::ElementTranslateBuilder::NewMeshType  newMeshOption)

Sets the option to create a new mesh or add the new elements to an existing mesh
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
newMeshOptionnew mesh option
void NXOpen::CAE::ElementTranslateBuilder::SetNumCopy ( int  numCopy)

Sets the number of copies to be created for each selected element
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
numCopynum copy
void NXOpen::CAE::ElementTranslateBuilder::SetOffset ( int  offset)

Sets the offset to be used to generate new element labels
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
offsetoffset
void NXOpen::CAE::ElementTranslateBuilder::SetSourcePoint ( NXOpen::Point sourcePoint)

Sets the source point .


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
sourcePointsourcepoint
void NXOpen::CAE::ElementTranslateBuilder::SetTargetPoint ( NXOpen::Point targetPoint)

Sets the target point .


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
targetPointtargetpoint
void NXOpen::CAE::ElementTranslateBuilder::SetVector ( NXOpen::Direction vector)

Sets the vector along which the selected elements should be translated
Created in NX5.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
vectorvector
NXOpen::Point* NXOpen::CAE::ElementTranslateBuilder::SourcePoint ( )

Returns the source point .


Created in NX12.0.0.

License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::TAngle ( )

Returns the theta angle for translation in a cylindrical/spherical coordinate system
Created in NX5.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAE::ElementTranslateBuilder::TargetPoint ( )

Returns the target point .


Created in NX12.0.0.

License requirements : None

NXOpen::Direction* NXOpen::CAE::ElementTranslateBuilder::Vector ( )

Returns the vector along which the selected elements should be translated
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::XDistance ( )

Returns the x component of distance for translation in a cartesian coordinate system
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::YDistance ( )

Returns the y component of distance for translation in a cartesian coordinate system
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::CAE::ElementTranslateBuilder::ZDistance ( )

Returns the z component of distance for translation in a cartesian/cylindrical coordinate system
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.