This class is used to construct the component name and part file name block, if it is in manage mode, we also have item number, item revision and item name . More...

Inheritance diagram for NXOpen::Layout2d::ComponentNameBuilder:

Public Member Functions
void	GenerateItemNumber ()
	Assigned an item number for 2D component Created in NX9.0.0.

void	GenerateRevision ()
	Assigned a revision for 2D component Created in NX9.0.0.

NXString	ItemName ()
	Returns the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

NXString	ItemNumber ()
	Returns the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

NXOpen::Layout2d::Layout2dDefinitionLocation	Location ()
	Returns the location type of the component indicating local, native or team center Created in NX9.0.0.

NXString	Name ()
	Returns the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

NXString	PartName ()
	Returns the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

NXString	Revision ()
	Returns the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetItemName (const NXString &itemName)
	Sets the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetItemName (const char *itemName)
	Sets the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetItemNumber (const NXString &itemNumber)
	Sets the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetItemNumber (const char *itemNumber)
	Sets the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation location)
	Sets the location type of the component indicating local, native or team center Created in NX9.0.0.

void	SetName (const NXString &name)
	Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

void	SetName (const char *name)
	Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

void	SetPartName (const NXString &partName)
	Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetPartName (const char *partName)
	Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetRevision (const NXString &revision)
	Sets the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

void	SetRevision (const char *revision)
	Sets the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX9.0.0.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

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

Detailed Description

This class is used to construct the component name and part file name block, if it is in manage mode, we also have item number, item revision and item name .

Created in NX9.0.0.

Member Function Documentation

void NXOpen::Layout2d::ComponentNameBuilder::GenerateItemNumber ( )

Assigned an item number for 2D component
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Layout2d::ComponentNameBuilder::GenerateRevision ( )

Assigned a revision for 2D component
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

NXString NXOpen::Layout2d::ComponentNameBuilder::ItemName ( )

Returns the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::ItemNumber ( )

Returns the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : None

NXOpen::Layout2d::Layout2dDefinitionLocation NXOpen::Layout2d::ComponentNameBuilder::Location ( )

Returns the location type of the component indicating local, native or team center
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::Name ( )

Returns the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::PartName ( )

Returns the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Layout2d::ComponentNameBuilder::Revision ( )

Returns the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : None

void NXOpen::Layout2d::ComponentNameBuilder::SetItemName ( const NXString & itemName )

Sets the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

itemName itemname

void NXOpen::Layout2d::ComponentNameBuilder::SetItemName ( const char * itemName )

Sets the itme name of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

itemName itemname

void NXOpen::Layout2d::ComponentNameBuilder::SetItemNumber ( const NXString & itemNumber )

Sets the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

itemNumber itemnumber

void NXOpen::Layout2d::ComponentNameBuilder::SetItemNumber ( const char * itemNumber )

Sets the itme number of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

itemNumber itemnumber

void NXOpen::Layout2d::ComponentNameBuilder::SetLocation ( NXOpen::Layout2d::Layout2dDefinitionLocation location )

Sets the location type of the component indicating local, native or team center
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

location location

void NXOpen::Layout2d::ComponentNameBuilder::SetName ( const NXString & name )

Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

name name

void NXOpen::Layout2d::ComponentNameBuilder::SetName ( const char * name )

Sets the JA method support for accessing and setting Component Name value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

name name

void NXOpen::Layout2d::ComponentNameBuilder::SetPartName ( const NXString & partName )

Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

partName partname

void NXOpen::Layout2d::ComponentNameBuilder::SetPartName ( const char * partName )

Sets the JA method support for accessing and setting Component part file mame value, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

partName partname

void NXOpen::Layout2d::ComponentNameBuilder::SetRevision ( const NXString & revision )

Sets the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

revision revision

void NXOpen::Layout2d::ComponentNameBuilder::SetRevision ( const char * revision )

Sets the revision of the 2D component if it is in manage mode NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

revision revision

virtual bool NXOpen::Layout2d::ComponentNameBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

Layout2d_ComponentNameBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation