Represents a collection of NXOpen::Layout2d::ComponentDefinition objects. More...

Inheritance diagram for NXOpen::Layout2d::ComponentDefinitionCollection:

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...

void	Delete (NXOpen::Layout2d::Layout2dDefinitionLocation location, const NXString &definitionPath)
	Deletes definition Created in NX11.0.0. More...

void	Delete (NXOpen::Layout2d::Layout2dDefinitionLocation location, const char *definitionPath)
	Deletes definition Created in NX11.0.0. More...

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

NXOpen::Layout2d::ComponentDefinition *	FindObject (const NXString &sid)
	Finds the NXOpen::Layout2d::ComponentDefinition with the given sid. More...

NXOpen::Layout2d::ComponentDefinition *	FindObject (const char *sid)
	Finds the NXOpen::Layout2d::ComponentDefinition with the given sid. More...

void	RefreshAllReferences ()
	Refreshes all definition references in part to obtain the actual out-of-date status of components Created in NX12.0.0. More...

void	Rename (NXOpen::Layout2d::Layout2dDefinitionLocation location, const NXString &definitionPath, const NXString &newName)
	Renames definition Created in NX11.0.0. More...

void	Rename (NXOpen::Layout2d::Layout2dDefinitionLocation location, const char definitionPath, const char newName)
	Renames definition Created in NX11.0.0. More...

void	SetAutomaticPreview (NXOpen::Layout2d::Layout2dDefinitionLocation location, const NXString &definitionPath, bool isAutomatic)
	Sets the automatic preview mode of definition with the given path Created in NX11.0.0. More...

void	SetAutomaticPreview (NXOpen::Layout2d::Layout2dDefinitionLocation location, const char *definitionPath, bool isAutomatic)
	Sets the automatic preview mode of definition with the given path Created in NX11.0.0. More...

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

void	Update (NXOpen::Layout2d::Layout2dDefinitionLocation location, const NXString &definitionPath)
	Updates definition with the given path Created in NX11.0.0. More...

void	Update (NXOpen::Layout2d::Layout2dDefinitionLocation location, const char *definitionPath)
	Updates definition with the given path Created in NX11.0.0. More...

void	UpdateImage (NXOpen::Layout2d::Layout2dDefinitionLocation location, const NXString &definitionPath, const NXString &imagePath)
	Updates definition preview Created in NX11.0.0. More...

void	UpdateImage (NXOpen::Layout2d::Layout2dDefinitionLocation location, const char definitionPath, const char imagePath)
	Updates definition preview Created in NX11.0.0. More...

Detailed Description

Represents a collection of NXOpen::Layout2d::ComponentDefinition objects.

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

Created in NX10.0.0.

Member Function Documentation

iterator NXOpen::Layout2d::ComponentDefinitionCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::Layout2d::ComponentDefinitionCollection::Delete	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const NXString &	definitionPath
	)

Deletes definition
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to delete
definitionPath	Path of the definition to delete

void NXOpen::Layout2d::ComponentDefinitionCollection::Delete	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const char *	definitionPath
	)

Deletes definition
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to delete
definitionPath	Path of the definition to delete

iterator NXOpen::Layout2d::ComponentDefinitionCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Layout2d::ComponentDefinition* NXOpen::Layout2d::ComponentDefinitionCollection::FindObject ( const NXString & sid )

Finds the NXOpen::Layout2d::ComponentDefinition with the given sid.

An exception will be thrown if no object can be found with the given sid. This method can only be used to find Local definitions

Returns: Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

sid	The sid of the definition to find

NXOpen::Layout2d::ComponentDefinition* NXOpen::Layout2d::ComponentDefinitionCollection::FindObject ( const char * sid )

Finds the NXOpen::Layout2d::ComponentDefinition with the given sid.

An exception will be thrown if no object can be found with the given sid. This method can only be used to find Local definitions

Returns: Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

sid	The sid of the definition to find

void NXOpen::Layout2d::ComponentDefinitionCollection::RefreshAllReferences ( )

Refreshes all definition references in part to obtain the actual out-of-date status of components
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")

void NXOpen::Layout2d::ComponentDefinitionCollection::Rename	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const NXString &	definitionPath,
		const NXString &	newName
	)

Renames definition
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to rename
definitionPath	Path of the definition to rename
newName	New definition name

void NXOpen::Layout2d::ComponentDefinitionCollection::Rename	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const char *	definitionPath,
		const char *	newName
	)

Renames definition
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to rename
definitionPath	Path of the definition to rename
newName	New definition name

void NXOpen::Layout2d::ComponentDefinitionCollection::SetAutomaticPreview	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const NXString &	definitionPath,
		bool	isAutomatic
	)

Sets the automatic preview mode of definition with the given path
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to set the preview mode
definitionPath	Path of the definition to set the preview mode
isAutomatic	isautomatic

void NXOpen::Layout2d::ComponentDefinitionCollection::SetAutomaticPreview	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const char *	definitionPath,
		bool	isAutomatic
	)

Sets the automatic preview mode of definition with the given path
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to set the preview mode
definitionPath	Path of the definition to set the preview mode
isAutomatic	isautomatic

tag_t NXOpen::Layout2d::ComponentDefinitionCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::Layout2d::ComponentDefinitionCollection::Update	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const NXString &	definitionPath
	)

Updates definition with the given path
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to update
definitionPath	Path of the definition to update

void NXOpen::Layout2d::ComponentDefinitionCollection::Update	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const char *	definitionPath
	)

Updates definition with the given path
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to update
definitionPath	Path of the definition to update

void NXOpen::Layout2d::ComponentDefinitionCollection::UpdateImage	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const NXString &	definitionPath,
		const NXString &	imagePath
	)

Updates definition preview
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to update image
definitionPath	Path of the definition to update image
imagePath	Path of the image file used to update definition preview

void NXOpen::Layout2d::ComponentDefinitionCollection::UpdateImage	(	NXOpen::Layout2d::Layout2dDefinitionLocation	location,
		const char *	definitionPath,
		const char *	imagePath
	)

Updates definition preview
Created in NX11.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

location	Location of the definition to update image
definitionPath	Path of the definition to update image
imagePath	Path of the image file used to update definition preview

The documentation for this class was generated from the following file:

Layout2d_ComponentDefinitionCollection.hxx

Classes

Public Member Functions

Detailed Description

Member Function Documentation