Represents a collection of layer categories
To obtain an instance of this class, refer to 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.

NXOpen::Layer::Category *	CreateCategory (const NXString &name, const NXString &description, const std::vector< int > &memberLayers)
	Creates a new layer category.

NXOpen::Layer::Category *	CreateCategory (const char name, const char description, const std::vector< int > &memberLayers)
	Creates a new layer category.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::Layer::Category *	FindObject (const NXString &name)
	Finds the Category with the given name.

NXOpen::Layer::Category *	FindObject (const char *name)
	Finds the Category with the given name.

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

Detailed Description

Represents a collection of layer categories
To obtain an instance of this class, refer to 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.

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.

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 Category with the given name.

   An exception will be thrown if no object can be found with the given name.
    @return

Created in NX3.0.0.

License requirements : None

Parameters

name	The name of the Category

NXOpen::Layer::Category* NXOpen::Layer::CategoryCollection::FindObject ( const char * name )

Finds the Category with the given name.

   An exception will be thrown if no object can be found with the given name.
    @return

Created in NX3.0.0.

License requirements : None

Parameters

name	The name of the 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: