Represents a builder to instantiate a symbol from a parameterized family of standard symbols defined in catalogs, eg. More...

Inheritance diagram for NXOpen::Annotations::SymbolCatalogBuilder:

Public Member Functions
void	GenerateItemNumber ()
	Generates the item number, valid in team center Created in NX8.0.0.

void	GenerateRevision ()
	Generates the revision number, valid in team center Created in NX8.0.0.

bool	IsPartSymbol ()
	Returns the variable of is part symbol or not, get it from the reuse library Created in NX8.0.0.

NXString	ItemName ()
	Returns the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

NXString	ItemNumber ()
	Returns the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

NXOpen::Annotations::SymbolCatalogParameterBuilder *	NewParameter ()
	Creates a Annotations::SymbolCatalogParameterBuilder object.

NXString	NodeString ()
	Returns the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

NXOpen::Annotations::SymbolCatalogParameterBuilderList *	ParameterList ()
	Returns the list containing the parameters used to create the symbol.

NXString	PartFileName ()
	Returns the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

NXString	Path ()
	Returns the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

NXString	Revision ()
	Returns the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetItemName (const NXString &itemName)
	Sets the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetItemName (const char *itemName)
	Sets the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetItemNumber (const NXString &itemNumber)
	Sets the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetItemNumber (const char *itemNumber)
	Sets the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetNodeString (const NXString &nodeString)
	Sets the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetNodeString (const char *nodeString)
	Sets the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetPartFileName (const NXString &partFileName)
	Sets the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetPartFileName (const char *partFileName)
	Sets the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetPartSymbol (bool isPartSymbol)
	Sets the variable of is part symbol or not, get it from the reuse library Created in NX8.0.0.

void	SetPath (const NXString &path)
	Sets the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetPath (const char *path)
	Sets the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetRevision (const NXString &revision)
	Sets the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

void	SetRevision (const char *revision)
	Sets the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free Created in NX8.0.0.

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

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

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

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

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

Represents a builder to instantiate a symbol from a parameterized family of standard symbols defined in catalogs, eg.

for standard fasteners.
To create a new instance of this class, use Annotations::CustomSymbolCollection::CreateSymbolCatalogBuilder

Created in NX8.0.0.

Member Function Documentation

void NXOpen::Annotations::SymbolCatalogBuilder::GenerateItemNumber ( )

Generates the item number, valid in team center
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

void NXOpen::Annotations::SymbolCatalogBuilder::GenerateRevision ( )

Generates the revision number, valid in team center
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

bool NXOpen::Annotations::SymbolCatalogBuilder::IsPartSymbol ( )

Returns the variable of is part symbol or not, get it from the reuse library
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::SymbolCatalogBuilder::ItemName ( )

Returns the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::SymbolCatalogBuilder::ItemNumber ( )

Returns the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::SymbolCatalogParameterBuilder* NXOpen::Annotations::SymbolCatalogBuilder::NewParameter ( )

Creates a Annotations::SymbolCatalogParameterBuilder object.

Returns: Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXString NXOpen::Annotations::SymbolCatalogBuilder::NodeString ( )

Returns the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::SymbolCatalogParameterBuilderList* NXOpen::Annotations::SymbolCatalogBuilder::ParameterList ( )

Returns the list containing the parameters used to create the symbol.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::SymbolCatalogBuilder::PartFileName ( )

Returns the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::SymbolCatalogBuilder::Path ( )

Returns the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::SymbolCatalogBuilder::Revision ( )

Returns the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::SymbolCatalogBuilder::SetItemName ( const NXString & itemName )

Sets the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

itemName itemname

void NXOpen::Annotations::SymbolCatalogBuilder::SetItemName ( const char * itemName )

Sets the Item Name, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

itemName itemname

void NXOpen::Annotations::SymbolCatalogBuilder::SetItemNumber ( const NXString & itemNumber )

Sets the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

itemNumber itemnumber

void NXOpen::Annotations::SymbolCatalogBuilder::SetItemNumber ( const char * itemNumber )

Sets the item number, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

itemNumber itemnumber

void NXOpen::Annotations::SymbolCatalogBuilder::SetNodeString ( const NXString & nodeString )

Sets the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

nodeString nodestring

void NXOpen::Annotations::SymbolCatalogBuilder::SetNodeString ( const char * nodeString )

Sets the node string of the fastener symbol, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

nodeString nodestring

void NXOpen::Annotations::SymbolCatalogBuilder::SetPartFileName ( const NXString & partFileName )

Sets the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

partFileName partfilename

void NXOpen::Annotations::SymbolCatalogBuilder::SetPartFileName ( const char * partFileName )

Sets the part file name, NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

partFileName partfilename

void NXOpen::Annotations::SymbolCatalogBuilder::SetPartSymbol ( bool isPartSymbol )

Sets the variable of is part symbol or not, get it from the reuse library
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

isPartSymbol True If it is part symbol

void NXOpen::Annotations::SymbolCatalogBuilder::SetPath ( const NXString & path )

Sets the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

path	location of symbol

void NXOpen::Annotations::SymbolCatalogBuilder::SetPath ( const char * path )

Sets the path, get it from the reuse library NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

path	location of symbol

void NXOpen::Annotations::SymbolCatalogBuilder::SetRevision ( const NXString & revision )

Sets the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

revision revision

void NXOpen::Annotations::SymbolCatalogBuilder::SetRevision ( const char * revision )

Sets the revision, valid in team center NOTE: Client must free the returned TEXT_p_t* with TEXT_free
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

revision revision

void NXOpen::Annotations::SymbolCatalogBuilder::SetSymbolName ( const NXString & symbolName )

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

Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

symbolName symbolname

void NXOpen::Annotations::SymbolCatalogBuilder::SetSymbolName ( const char * symbolName )

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

Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

symbolName symbolname

NXString NXOpen::Annotations::SymbolCatalogBuilder::SymbolName ( )

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

Created in NX8.0.0.

License requirements : None

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

Annotations_SymbolCatalogBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation