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

Provides methods for managing DOFSet NXOpen::CAE::CaeDOFSet. More...

Inheritance diagram for NXOpen::CAE::CaeDOFSetCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::CAE::CaeDOFSetCopyDofset (const NXString &dofsetName, NXOpen::CAE::CaeDOFSet *sourceDofset)
 Copy a DOFSet. More...
 
NXOpen::CAE::CaeDOFSetCopyDofset (const char *dofsetName, NXOpen::CAE::CaeDOFSet *sourceDofset)
 Copy a DOFSet. More...
 
NXOpen::CAE::CaeDOFSetCreateDofset (const NXString &dofsetName, const std::vector< NXOpen::CAE::FENode * > &nodes, const std::vector< bool > &dof1, const std::vector< bool > &dof2, const std::vector< bool > &dof3, const std::vector< bool > &dof4, const std::vector< bool > &dof5, const std::vector< bool > &dof6)
 Create a DOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node. More...
 
NXOpen::CAE::CaeDOFSetCreateDofset (const char *dofsetName, const std::vector< NXOpen::CAE::FENode * > &nodes, const std::vector< bool > &dof1, const std::vector< bool > &dof2, const std::vector< bool > &dof3, const std::vector< bool > &dof4, const std::vector< bool > &dof5, const std::vector< bool > &dof6)
 Create a DOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node. More...
 
NXOpen::CAE::CaeDOFSetCreateExclusiveOrDofset (const NXString &dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create a XOR of DOFSets. More...
 
NXOpen::CAE::CaeDOFSetCreateExclusiveOrDofset (const char *dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create a XOR of DOFSets. More...
 
NXOpen::CAE::CaeDOFSetCreateIntersectionDofset (const NXString &dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create an Intersection of DOFSets. More...
 
NXOpen::CAE::CaeDOFSetCreateIntersectionDofset (const char *dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create an Intersection of DOFSets. More...
 
NXOpen::CAE::CaeDOFSetCreateUnionDofset (const NXString &dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create a Union of DOFSets. More...
 
NXOpen::CAE::CaeDOFSetCreateUnionDofset (const char *dofsetName, const std::vector< NXOpen::CAE::CaeDOFSet * > &objects)
 Create a Union of DOFSets. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::CaeDOFSetFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::CAE::CaeDOFSet with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::CaeDOFSetFindObject (const char *journalIdentifier)
 Finds the NXOpen::CAE::CaeDOFSet with the given identifier as recorded in a journal. More...
 
void QueryDofsetList (std::vector< NXOpen::TaggedObject * > &objects)
 Query DOFSets list
Created in NX7.5.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Provides methods for managing DOFSet NXOpen::CAE::CaeDOFSet.


To obtain an instance of this class, refer to NXOpen::CAE::SimSimulation

Created in NX7.5.0.

Member Function Documentation

iterator NXOpen::CAE::CaeDOFSetCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CopyDofset ( const NXString dofsetName,
NXOpen::CAE::CaeDOFSet sourceDofset 
)

Copy a DOFSet.

Returns
The copied DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the copied DOFSet
sourceDofsetThe source DOFSet object
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CopyDofset ( const char *  dofsetName,
NXOpen::CAE::CaeDOFSet sourceDofset 
)

Copy a DOFSet.

Returns
The copied DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the copied DOFSet
sourceDofsetThe source DOFSet object
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateDofset ( const NXString dofsetName,
const std::vector< NXOpen::CAE::FENode * > &  nodes,
const std::vector< bool > &  dof1,
const std::vector< bool > &  dof2,
const std::vector< bool > &  dof3,
const std::vector< bool > &  dof4,
const std::vector< bool > &  dof5,
const std::vector< bool > &  dof6 
)

Create a DOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.

A false would mean that the dof is not included for that node.

Returns
The created DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of a DOFSet
nodesArray of nodes in the DOFSet NXOpen::CAE::FENode
dof1Array of DOF1 values
dof2Array of DOF2 values
dof3Array of DOF3 values
dof4Array of DOF4 values
dof5Array of DOF5 values
dof6Array of DOF6 values
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateDofset ( const char *  dofsetName,
const std::vector< NXOpen::CAE::FENode * > &  nodes,
const std::vector< bool > &  dof1,
const std::vector< bool > &  dof2,
const std::vector< bool > &  dof3,
const std::vector< bool > &  dof4,
const std::vector< bool > &  dof5,
const std::vector< bool > &  dof6 
)

Create a DOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.

A false would mean that the dof is not included for that node.

Returns
The created DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of a DOFSet
nodesArray of nodes in the DOFSet NXOpen::CAE::FENode
dof1Array of DOF1 values
dof2Array of DOF2 values
dof3Array of DOF3 values
dof4Array of DOF4 values
dof5Array of DOF5 values
dof6Array of DOF6 values
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateExclusiveOrDofset ( const NXString dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create a XOR of DOFSets.

Returns
The created XOR DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the XOR DOFSet
objectsDOFSets that need to be XORed
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateExclusiveOrDofset ( const char *  dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create a XOR of DOFSets.

Returns
The created XOR DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the XOR DOFSet
objectsDOFSets that need to be XORed
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateIntersectionDofset ( const NXString dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create an Intersection of DOFSets.

Returns
The created intersection DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the intersection DOFSet
objectsDOFSets that need to be intersected
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateIntersectionDofset ( const char *  dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create an Intersection of DOFSets.

Returns
The created intersection DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the intersection DOFSet
objectsDOFSets that need to be intersected
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateUnionDofset ( const NXString dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create a Union of DOFSets.

Returns
The created union DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the unioned DOFSet
objectsDOFSets that need to be unioned
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::CreateUnionDofset ( const char *  dofsetName,
const std::vector< NXOpen::CAE::CaeDOFSet * > &  objects 
)

Create a Union of DOFSets.

Returns
The created union DOFSet object
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
dofsetNameName of the unioned DOFSet
objectsDOFSets that need to be unioned
iterator NXOpen::CAE::CaeDOFSetCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::CAE::CaeDOFSet with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
The found DOFSet
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
journalIdentifierIdentifier of the DOFSet you want
NXOpen::CAE::CaeDOFSet* NXOpen::CAE::CaeDOFSetCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::CAE::CaeDOFSet with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
The found DOFSet
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling")
Parameters
journalIdentifierIdentifier of the DOFSet you want
void NXOpen::CAE::CaeDOFSetCollection::QueryDofsetList ( std::vector< NXOpen::TaggedObject * > &  objects)

Query DOFSets list
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
objectsobjects
tag_t NXOpen::CAE::CaeDOFSetCollection::Tag ( ) const

Returns the tag of this object.


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