Represents a collection of layer categories
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX3.0.0.
More...
Inheritance diagram for NXOpen::Layer::CategoryCollection:
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::Layer::Category * | CreateCategory (const NXString &name, const NXString &description, const std::vector< int > &memberLayers) |
| Creates a new layer category. More... | |
| NXOpen::Layer::Category * | CreateCategory (const char *name, const char *description, const std::vector< int > &memberLayers) |
| Creates a new layer category. More... | |
| iterator | end () |
| Returns an iterator addressing one past the last element. More... | |
| NXOpen::Layer::Category * | FindObject (const NXString &name) |
| Finds the NXOpen::Layer::Category with the given name. More... | |
| NXOpen::Layer::Category * | FindObject (const char *name) |
| Finds the NXOpen::Layer::Category with the given name. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents a collection of layer categories
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX3.0.0.
Member Function Documentation
| iterator NXOpen::Layer::CategoryCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Layer::Category* NXOpen::Layer::CategoryCollection::CreateCategory | ( | const NXString & | name, |
| const NXString & | description, | ||
| const std::vector< int > & | memberLayers | ||
| ) |
Creates a new layer category.
- Returns
- The new category
Created in NX3.0.0.
License requirements : None
- Parameters
-
name The name must not NULL and must not already be used by another layer category. description Optional
NOTE: The full Unicode character set is not supported for this parameter.
memberLayers Layers to be placed into the category
| NXOpen::Layer::Category* NXOpen::Layer::CategoryCollection::CreateCategory | ( | const char * | name, |
| const char * | description, | ||
| const std::vector< int > & | memberLayers | ||
| ) |
Creates a new layer category.
- Returns
- The new category
Created in NX3.0.0.
License requirements : None
- Parameters
-
name The name must not NULL and must not already be used by another layer category. description Optional
NOTE: The full Unicode character set is not supported for this parameter.
memberLayers Layers to be placed into the category
| iterator NXOpen::Layer::CategoryCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Layer::Category* NXOpen::Layer::CategoryCollection::FindObject | ( | const NXString & | name | ) |
Finds the NXOpen::Layer::Category with the given name.
An exception will be thrown if no object can be found with the given name.
- Returns
Created in NX3.0.0.
License requirements : None
- Parameters
-
name The name of the NXOpen::Layer::Category
| NXOpen::Layer::Category* NXOpen::Layer::CategoryCollection::FindObject | ( | const char * | name | ) |
Finds the NXOpen::Layer::Category with the given name.
An exception will be thrown if no object can be found with the given name.
- Returns
Created in NX3.0.0.
License requirements : None
- Parameters
-
name The name of the NXOpen::Layer::Category
| tag_t NXOpen::Layer::CategoryCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Layer_CategoryCollection.hxx