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

Represents a CAE::MultipleElementCreateBuilder which can be used to create mutiple elements in one efficient opertation. More...

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

Public Member Functions

void AddElement (const std::vector< NXOpen::CAE::FENode * > &nodes)
 Adds new element definition defined by the list of input CAE::FENode objects.
 
void AddElement (const std::vector< NXOpen::CAE::FENode * > &nodes, int label)
 Adds new element definition defined by the list of input CAE::FENode objects.
 
std::vector
< NXOpen::CAE::FEElement * > 
CommitElements ()
 Commits the Builder, which creates elements as they were defined and returns the newly create elements.
 
NXOpen::CAE::ElementTypeBuilderElementType ()
 Returns the element type builder.
 
int LabelIncrement ()
 Returns the label increment used when calculating next element label when assigning element labels
Created in NX7.5.2.
 
void SetLabelIncrement (int increment)
 Sets the label increment used when calculating next element label when assigning element labels
Created in NX7.5.2.
 
void SetStartLabel (int label)
 Sets the starting label used to assign element labels, if no explicit labels were defined.
 
int StartLabel ()
 Returns the starting label used to assign element labels, if no explicit labels were defined.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a CAE::MultipleElementCreateBuilder which can be used to create mutiple elements in one efficient opertation.

<br> 

The general procedure for creating elements is to:

  1. Define the type of elements to be create through the CAE::ElementTypeBuilder and the properties of CAE::ElementTypeBuilder::ElementTypeName and CAE::ElementTypeBuilder::SetElementTypeName
  2. Optionally define elements labeling requirements through CAE::MultipleElementCreateBuilder::StartLabel and CAE::MultipleElementCreateBuilder::SetStartLabel and CAE::MultipleElementCreateBuilder::LabelIncrement and CAE::MultipleElementCreateBuilder::SetLabelIncrement
  3. Define elements through CAE::MultipleElementCreateBuilder::AddElement
  4. Create Mesh and elements through Builder::Commit or CAE::MultipleElementCreateBuilder::CommitElements . Commiting the builder removes the current element defintions so that it can be reused to create more elements.

The

To create a new instance of this class, use CAE::NodeElementManager::CreateMultipleElementCreateBuilder

Created in NX7.5.2.

Member Function Documentation

void NXOpen::CAE::MultipleElementCreateBuilder::AddElement ( const std::vector< NXOpen::CAE::FENode * > &  nodes)

Adds new element definition defined by the list of input CAE::FENode objects.

New element will be created only after CAE::MultipleElementCreateBuilder::CommitElements is done. Since element labels weren't specified, the builder will assign them automatically based on the setting of CAE::MultipleElementCreateBuilder::StartLabel and CAE::MultipleElementCreateBuilder::SetStartLabel and CAE::MultipleElementCreateBuilder::LabelIncrement and CAE::MultipleElementCreateBuilder::SetLabelIncrement
Created in NX7.5.2.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
nodesinput list of nodes
void NXOpen::CAE::MultipleElementCreateBuilder::AddElement ( const std::vector< NXOpen::CAE::FENode * > &  nodes,
int  label 
)

Adds new element definition defined by the list of input CAE::FENode objects.

New element will be created only after CAE::MultipleElementCreateBuilder::CommitElements is done.


Created in NX7.5.2.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
nodesinput list of nodes, The number of nodes and the order of the nodes must be consistent with the defined element type.
labelnew FEElement label. If the specified label is less than or equal to 0 then the builder will automatically assign a valid label based on the builders labeling rules. If a label is specified it must be unique in this part.
std::vector<NXOpen::CAE::FEElement *> NXOpen::CAE::MultipleElementCreateBuilder::CommitElements ( )

Commits the Builder, which creates elements as they were defined and returns the newly create elements.

       The method @link Builder::Commit Builder::Commit@endlink  will also do the same thing
       except instead of returning elements, it will return the newly created @link CAE::Mesh CAE::Mesh@endlink  which
       contains the new elements.
       @link Builder::GetCommittedObjects Builder::GetCommittedObjects@endlink 
       can't be used to return elements since they are not of type @link  NXObject  NXObject@endlink .  It will however 
       return the newly created @link CAE::Mesh CAE::Mesh@endlink 
     @return  new FEElements positions 


Created in NX7.5.2.

License requirements : nx_masterfem ("Finite Element Modeling")

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

Returns the element type builder.

Through the CAE::ElementTypeBuilder you can specify both the type of element to create as well as the destination CAE::MeshCollector the new elements will be placed in.
Created in NX7.5.2.

License requirements : nx_masterfem ("Finite Element Modeling")

int NXOpen::CAE::MultipleElementCreateBuilder::LabelIncrement ( )

Returns the label increment used when calculating next element label when assigning element labels
Created in NX7.5.2.



License requirements : None

void NXOpen::CAE::MultipleElementCreateBuilder::SetLabelIncrement ( int  increment)

Sets the label increment used when calculating next element label when assigning element labels
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
incrementincrement
void NXOpen::CAE::MultipleElementCreateBuilder::SetStartLabel ( int  label)

Sets the starting label used to assign element labels, if no explicit labels were defined.

If no start label is specified, the next available element for this part.
Created in NX7.5.2.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
labellabel
int NXOpen::CAE::MultipleElementCreateBuilder::StartLabel ( )

Returns the starting label used to assign element labels, if no explicit labels were defined.

If no start label is specified, the next available element for this part.
Created in NX7.5.2.

License requirements : None


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