NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::SymbolCatalogBuilder Class Reference

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

Inheritance diagram for NXOpen::Annotations::SymbolCatalogBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void GenerateItemNumber ()
 Generates the item number, valid in team center
More...
 
void GenerateRevision ()
 Generates the revision number, valid in team center
More...
 
NXOpen::PDM::PartOperationCreateBuilderGetPartOperationCreateBuilder ()
 Gets NXOpen::PDM::PartOperationBuilder. More...
 
bool IsPartSymbol ()
 Returns the variable of is part symbol or not, get it from the reuse library
Created in NX8.0.0. More...
 
NXString ItemName ()
 Returns the Item Name, valid in team center
More...
 
NXString ItemNumber ()
 Returns the item number, valid in team center
More...
 
NXOpen::Annotations::SymbolCatalogParameterBuilderNewParameter ()
 Creates a NXOpen::Annotations::SymbolCatalogParameterBuilder object. More...
 
NXString NodeString ()
 Returns the node string of the fastener symbol
Created in NX8.0.0. More...
 
NXOpen::Annotations::SymbolCatalogParameterBuilderListParameterList ()
 Returns the list containing the parameters used to create the symbol. More...
 
NXString PartFileName ()
 Returns the part file name
Created in NX8.0.0. More...
 
NXString Path ()
 Returns the path, get it from the reuse library
Created in NX8.0.0. More...
 
NXString Revision ()
 Returns the revision, valid in team center
More...
 
void SetItemName (const NXString &itemName)
 Sets the Item Name, valid in team center
More...
 
void SetItemName (const char *itemName)
 Sets the Item Name, valid in team center
More...
 
void SetItemNumber (const NXString &itemNumber)
 Sets the item number, valid in team center
More...
 
void SetItemNumber (const char *itemNumber)
 Sets the item number, valid in team center
More...
 
void SetNodeString (const NXString &nodeString)
 Sets the node string of the fastener symbol
Created in NX8.0.0. More...
 
void SetNodeString (const char *nodeString)
 Sets the node string of the fastener symbol
Created in NX8.0.0. More...
 
void SetPartFileName (const NXString &partFileName)
 Sets the part file name
Created in NX8.0.0. More...
 
void SetPartFileName (const char *partFileName)
 Sets the part file name
Created in NX8.0.0. More...
 
void SetPartOperationCreateBuilder (NXOpen::PDM::PartOperationCreateBuilder *partOperationBuilder)
 Sets NXOpen::PDM::PartOperationBuilder
Created in NX10.0.0. More...
 
void SetPartSymbol (bool isPartSymbol)
 Sets the variable of is part symbol or not, get it from the reuse library
Created in NX8.0.0. More...
 
void SetPath (const NXString &path)
 Sets the path, get it from the reuse library
Created in NX8.0.0. More...
 
void SetPath (const char *path)
 Sets the path, get it from the reuse library
Created in NX8.0.0. More...
 
void SetRevision (const NXString &revision)
 Sets the revision, valid in team center
More...
 
void SetRevision (const char *revision)
 Sets the revision, valid in team center
More...
 
void SetSymbolName (const NXString &symbolName)
 Sets the name of the symbol. More...
 
void SetSymbolName (const char *symbolName)
 Sets the name of the symbol. More...
 
NXString SymbolName ()
 Returns the name of the symbol. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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

for standard fasteners.


To create a new instance of this class, use NXOpen::Annotations::CustomSymbolCollection::CreateSymbolCatalogBuilder

Created in NX8.0.0.

Member Function Documentation

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

Generates the item number, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Annotations::SymbolCatalogBuilder::SetItemNumber instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Generates the revision number, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Annotations::SymbolCatalogBuilder::SetRevision instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

NXOpen::PDM::PartOperationCreateBuilder* NXOpen::Annotations::SymbolCatalogBuilder::GetPartOperationCreateBuilder ( )

Gets NXOpen::PDM::PartOperationBuilder.

Returns

Created in NX10.0.0.

License requirements : None
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

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : None

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

Returns the item number, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : None

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

Creates a NXOpen::Annotations::SymbolCatalogParameterBuilder object.

Returns

Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")
NXString NXOpen::Annotations::SymbolCatalogBuilder::NodeString ( )

Returns the node string of the fastener symbol
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
Created in NX8.0.0.



License requirements : None

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

Returns the path, get it from the reuse library
Created in NX8.0.0.



License requirements : None

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

Returns the revision, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : None

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

Sets the Item Name, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Sets the Item Name, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

Parameters
itemNameitemname
void NXOpen::Annotations::SymbolCatalogBuilder::SetItemNumber ( const NXString itemNumber)

Sets the item number, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Sets the item number, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

Parameters
itemNumberitemnumber
void NXOpen::Annotations::SymbolCatalogBuilder::SetNodeString ( const NXString nodeString)

Sets the node string of the fastener symbol
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

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

Sets the node string of the fastener symbol
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
nodeStringnodestring
void NXOpen::Annotations::SymbolCatalogBuilder::SetPartFileName ( const NXString partFileName)

Sets the part file name
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

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

Sets the part file name
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
partFileNamepartfilename
void NXOpen::Annotations::SymbolCatalogBuilder::SetPartOperationCreateBuilder ( NXOpen::PDM::PartOperationCreateBuilder partOperationBuilder)

Sets NXOpen::PDM::PartOperationBuilder
Created in NX10.0.0.



License requirements : drafting ("DRAFTING")

Parameters
partOperationBuilderpartoperationbuilder
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_layout ("NX Layout")

Parameters
isPartSymbolTrue If it is part symbol
void NXOpen::Annotations::SymbolCatalogBuilder::SetPath ( const NXString path)

Sets the path, get it from the reuse library
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
pathlocation of symbol
void NXOpen::Annotations::SymbolCatalogBuilder::SetPath ( const char *  path)

Sets the path, get it from the reuse library
Created in NX8.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
pathlocation of symbol
void NXOpen::Annotations::SymbolCatalogBuilder::SetRevision ( const NXString revision)

Sets the revision, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Sets the revision, valid in team center

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::PDM::PartOperationCreateBuilder instead.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

Parameters
revisionrevision
void NXOpen::Annotations::SymbolCatalogBuilder::SetSymbolName ( const NXString symbolName)

Sets the name of the symbol.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Sets the name of the symbol.


Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

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

Returns the name of the symbol.


Created in NX8.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.