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

Provides methods for managing CAE::CaeRegion in a sim part. More...

Inheritance diagram for NXOpen::CAE::CaeRegionCollection:
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::CaeRegionCopy (NXOpen::CAE::CaeRegion *tSourceRegion)
 Copies a CAE::CaeRegion. More...
 
NXOpen::CAE::CaeRegionCreateCaeRegion (const NXString &descriptorName, const NXString &name, int label)
 Creates a CAE::CaeRegion. More...
 
NXOpen::CAE::CaeRegionCreateCaeRegion (const char *descriptorName, const char *name, int label)
 Creates a CAE::CaeRegion. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::CAE::CaeRegionFindObject (const NXString &journalIdentifier)
 Finds the CAE::CaeRegion with the given identifier as recorded in a journal. More...
 
NXOpen::CAE::CaeRegionFindObject (const char *journalIdentifier)
 Finds the CAE::CaeRegion with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Provides methods for managing CAE::CaeRegion in a sim part.


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

Created in NX7.0.0.

Member Function Documentation

iterator NXOpen::CAE::CaeRegionCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::CAE::CaeRegion* NXOpen::CAE::CaeRegionCollection::Copy ( NXOpen::CAE::CaeRegion tSourceRegion)

Copies a CAE::CaeRegion.

Returns
newly created region
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
tSourceRegionsource region to be copied
NXOpen::CAE::CaeRegion* NXOpen::CAE::CaeRegionCollection::CreateCaeRegion ( const NXString descriptorName,
const NXString name,
int  label 
)

Creates a CAE::CaeRegion.

Returns
Region object created
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
descriptorNameName of the region descriptor
nameName of the region
labelLabel of the region, input 0 to get next available label
NXOpen::CAE::CaeRegion* NXOpen::CAE::CaeRegionCollection::CreateCaeRegion ( const char *  descriptorName,
const char *  name,
int  label 
)

Creates a CAE::CaeRegion.

Returns
Region object created
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
descriptorNameName of the region descriptor
nameName of the region
labelLabel of the region, input 0 to get next available label
iterator NXOpen::CAE::CaeRegionCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::CAE::CaeRegion* NXOpen::CAE::CaeRegionCollection::FindObject ( const NXString journalIdentifier)

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

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

Returns
Region found
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
journalIdentifierIdentifier to be found
NXOpen::CAE::CaeRegion* NXOpen::CAE::CaeRegionCollection::FindObject ( const char *  journalIdentifier)

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

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

Returns
Region found
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
journalIdentifierIdentifier to be found
tag_t NXOpen::CAE::CaeRegionCollection::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.