NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::SymbolCatalogBuilder Class Reference

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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::SymbolCatalogParameterBuilderNewParameter ()
 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::SymbolCatalogParameterBuilderListParameterList ()
 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 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 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 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 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 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 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.
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.

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

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



License requirements : nx_drafting_plus ("Drafting Plus")

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



License requirements : nx_drafting_plus ("Drafting Plus")

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



License requirements : None

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

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

Creates a Annotations::SymbolCatalogParameterBuilder object.

Returns:

Created in NX8.0.0.

License requirements : nx_drafting_plus ("Drafting Plus")

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

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


Created in NX8.0.0.

License requirements : None

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

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

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

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 ("Drafting Plus")

Parameters:
itemNameitemname

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 ("Drafting Plus")

Parameters:
itemNumberitemnumber

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 ("Drafting Plus")

Parameters:
nodeStringnodestring

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 ("Drafting Plus")

Parameters:
partFileNamepartfilename

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 ("Drafting Plus")

Parameters:
isPartSymbolTrue If it is part symbol

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 ("Drafting Plus")

Parameters:
pathlocation of symbol

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 ("Drafting Plus")

Parameters:
revisionrevision

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 ("Drafting Plus")

Parameters:
symbolNamesymbolname

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.