PlcVendorSymbolBuilder Class¶
-
class
NXOpen.AME.
PlcVendorSymbolBuilder
¶ Bases:
NXOpen.Builder
Represents a Subnet creation class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreatePlcVendorSymbolBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
BitOffset | Returns or sets the bit |
ByteOffset | Returns or sets the byte |
DataType | Returns or sets the type |
EnumDataLength | Returns or sets the EnumDataLength |
Indicator | Returns or sets the Indicator |
SelectionChannel | Returns the selection ParentObject (parent of the plc 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. |
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. |
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¶
BitOffset¶
-
PlcVendorSymbolBuilder.
BitOffset
¶ Returns or sets the bit
-------------------------------------
Getter Method
Signature
BitOffset
Returns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BitOffset
Parameters: bitOffset (int) – New in version NX12.0.0.
License requirements: None.
ByteOffset¶
-
PlcVendorSymbolBuilder.
ByteOffset
¶ Returns or sets the byte
-------------------------------------
Getter Method
Signature
ByteOffset
Returns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByteOffset
Parameters: byteOffset (int) – New in version NX12.0.0.
License requirements: None.
DataType¶
-
PlcVendorSymbolBuilder.
DataType
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
DataType
Returns: Return type: NXOpen.AME.PlcDataType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DataType
Parameters: type ( NXOpen.AME.PlcDataType
) –New in version NX12.0.0.
License requirements: None.
EnumDataLength¶
-
PlcVendorSymbolBuilder.
EnumDataLength
¶ Returns or sets the EnumDataLength
-------------------------------------
Getter Method
Signature
EnumDataLength
Returns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EnumDataLength
Parameters: enum01 (int) – New in version NX12.0.0.
License requirements: None.
Indicator¶
-
PlcVendorSymbolBuilder.
Indicator
¶ Returns or sets the Indicator
-------------------------------------
Getter Method
Signature
Indicator
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Indicator
Parameters: indicator (str) – New in version NX12.0.0.
License requirements: None.
SelectionChannel¶
-
PlcVendorSymbolBuilder.
SelectionChannel
¶ Returns the selection ParentObject (parent of the plc symbol)
-------------------------------------
Getter Method
Signature
SelectionChannel
Returns: Return type: NXOpen.AME.SelectAMEBaseNode
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
PlcVendorSymbolBuilder.
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.