SymbolCatalogBuilder Class¶
-
class
NXOpen.Annotations.
SymbolCatalogBuilder
¶ Bases:
NXOpen.Builder
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()
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
IsPartSymbol | Returns or sets the variable of is part symbol or not, get it from the reuse library |
ItemName | Returns or sets the Item Name, valid in team center |
ItemNumber | Returns or sets the item number, valid in team center |
NodeString | Returns or sets the node string of the fastener symbol |
ParameterList | Returns the list containing the parameters used to create the symbol. |
PartFileName | Returns or sets the part file name |
Path | Returns or sets the path, get it from the reuse library |
Revision | Returns or sets the revision, valid in team center |
SymbolName | Returns or sets the name of the symbol. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GenerateItemNumber | Generates the item number, valid in team center |
GenerateRevision | Generates the revision number, valid in team center |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetPartOperationCreateBuilder | Gets NXOpen.PDM.PartOperationBuilder @return |
NewParameter | Creates a NXOpen.Annotations.SymbolCatalogParameterBuilder object. |
SetPartOperationCreateBuilder | Sets NXOpen.PDM.PartOperationBuilder |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
IsPartSymbol¶
-
SymbolCatalogBuilder.
IsPartSymbol
¶ Returns or sets the variable of is part symbol or not, get it from the reuse library
-------------------------------------
Getter Method
Signature
IsPartSymbol()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsPartSymbol(isPartSymbol)
Parameters: isPartSymbol (bool) – True If it is part symbol New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
ItemName¶
-
SymbolCatalogBuilder.
ItemName
¶ Returns or sets the Item Name, valid in team center
-------------------------------------
Getter Method
Signature
ItemName()
Returns: Return type: str New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
ItemName(itemName)
Parameters: itemName (str) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: nx_layout (“NX Layout”)
ItemNumber¶
-
SymbolCatalogBuilder.
ItemNumber
¶ Returns or sets the item number, valid in team center
-------------------------------------
Getter Method
Signature
ItemNumber()
Returns: Return type: str New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
ItemNumber(itemNumber)
Parameters: itemNumber (str) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: nx_layout (“NX Layout”)
NodeString¶
-
SymbolCatalogBuilder.
NodeString
¶ Returns or sets the node string of the fastener symbol
-------------------------------------
Getter Method
Signature
NodeString()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NodeString(nodeString)
Parameters: nodeString (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
ParameterList¶
-
SymbolCatalogBuilder.
ParameterList
¶ Returns the list containing the parameters used to create the symbol.
-------------------------------------
Getter Method
Signature
ParameterList()
Returns: Return type: NXOpen.Annotations.SymbolCatalogParameterBuilderList
New in version NX8.0.0.
License requirements: None.
PartFileName¶
-
SymbolCatalogBuilder.
PartFileName
¶ Returns or sets the part file name
-------------------------------------
Getter Method
Signature
PartFileName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PartFileName(partFileName)
Parameters: partFileName (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
Path¶
-
SymbolCatalogBuilder.
Path
¶ Returns or sets the path, get it from the reuse library
-------------------------------------
Getter Method
Signature
Path()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Path(path)
Parameters: path (str) – location of symbol New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
Revision¶
-
SymbolCatalogBuilder.
Revision
¶ Returns or sets the revision, valid in team center
-------------------------------------
Getter Method
Signature
Revision()
Returns: Return type: str New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Revision(revision)
Parameters: revision (str) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.PDM.PartOperationCreateBuilder
instead.License requirements: nx_layout (“NX Layout”)
SymbolName¶
-
SymbolCatalogBuilder.
SymbolName
¶ Returns or sets the name of the symbol.
-------------------------------------
Getter Method
Signature
SymbolName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolName(symbolName)
Parameters: symbolName (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
GenerateItemNumber¶
-
SymbolCatalogBuilder.
GenerateItemNumber
¶ Generates the item number, valid in team center
Signature
GenerateItemNumber()
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.SymbolCatalogBuilder.ItemNumber()
instead.License requirements: nx_layout (“NX Layout”)
GenerateRevision¶
-
SymbolCatalogBuilder.
GenerateRevision
¶ Generates the revision number, valid in team center
Signature
GenerateRevision()
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.SymbolCatalogBuilder.Revision()
instead.License requirements: nx_layout (“NX Layout”)
GetPartOperationCreateBuilder¶
-
SymbolCatalogBuilder.
GetPartOperationCreateBuilder
¶ Gets
NXOpen.PDM.PartOperationBuilder
Signature
GetPartOperationCreateBuilder()
Returns: Return type: NXOpen.PDM.PartOperationCreateBuilder
New in version NX10.0.0.
License requirements: None.
NewParameter¶
-
SymbolCatalogBuilder.
NewParameter
¶ Creates a
NXOpen.Annotations.SymbolCatalogParameterBuilder
object.Signature
NewParameter()
Returns: Return type: NXOpen.Annotations.SymbolCatalogParameterBuilder
New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
SetPartOperationCreateBuilder¶
-
SymbolCatalogBuilder.
SetPartOperationCreateBuilder
¶ Sets
NXOpen.PDM.PartOperationBuilder
Signature
SetPartOperationCreateBuilder(partOperationBuilder)
Parameters: partOperationBuilder ( NXOpen.PDM.PartOperationCreateBuilder
) –New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
SymbolCatalogBuilder.
Validate
¶ 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.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.