PlcSymbolBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PlcSymbolBuilder Class

class `NXOpen.AME.``PlcSymbolBuilder`

  Bases: `NXOpen.Builder`

  Class to create Functional Tags and assign them to PLC Channels

  To create a new instance of this class, use `NXOpen.AME.AMEManager.CreatePlcSymbolBuilder()`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
DataTypeSource | Returns or sets the data type source
Description | Returns or sets the string description
HWAddress | Returns or sets the string hwaddress
HWAddressOffsetBit | Returns or sets the int hwaddress offset bit
HWAddressOffsetByte | Returns or sets the int hwaddress offset byte
Indicator | Returns or sets the string indicator
MemorySection | Returns or sets the enum io type
SelectedUDTFromLibrary | Returns the library UDT selection
SelectionParentObject | Returns the selection ParentObject (parent of the plc symbol)
SymbolName | Returns or sets the string symbol name
Tag | Returns the Tag for this object.
UdtByName | Returns or sets the string udt by name data type
UdtFromProject | Returns the project UDT selection

# 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.
GetDataType | Get data type
GetObject | Returns the object currently being edited by this builder.
SetDataType | Set data type
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

## DataTypeSource

`PlcSymbolBuilder.``DataTypeSource`

  Returns or sets the data type source

  `-------------------------------------`

  Getter Method

  Signature `DataTypeSource`

  Returns: |
  Return type: | `NXOpen.AME.PlcDataTypeSource`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `DataTypeSource`

  Parameters: | dataTypeSource (`NXOpen.AME.PlcDataTypeSource`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Description

`PlcSymbolBuilder.``Description`

  Returns or sets the string description

  `-------------------------------------`

  Getter Method

  Signature `Description`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `Description`

  Parameters: | description (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## HWAddress

`PlcSymbolBuilder.``HWAddress`

  Returns or sets the string hwaddress

  `-------------------------------------`

  Getter Method

  Signature `HWAddress`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `HWAddress`

  Parameters: | hWAddress (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## HWAddressOffsetBit

`PlcSymbolBuilder.``HWAddressOffsetBit`

  Returns or sets the int hwaddress offset bit

  `-------------------------------------`

  Getter Method

  Signature `HWAddressOffsetBit`

  Returns: |
  Return type: | int

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `HWAddressOffsetBit`

  Parameters: | hWAddressOffsetBit (int) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## HWAddressOffsetByte

`PlcSymbolBuilder.``HWAddressOffsetByte`

  Returns or sets the int hwaddress offset byte

  `-------------------------------------`

  Getter Method

  Signature `HWAddressOffsetByte`

  Returns: |
  Return type: | int

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `HWAddressOffsetByte`

  Parameters: | hWAddress (int) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Indicator

`PlcSymbolBuilder.``Indicator`

  Returns or sets the string indicator

  `-------------------------------------`

  Getter Method

  Signature `Indicator`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `Indicator`

  Parameters: | indicator (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## MemorySection

`PlcSymbolBuilder.``MemorySection`

  Returns or sets the enum io type

  `-------------------------------------`

  Getter Method

  Signature `MemorySection`

  Returns: |
  Return type: | `NXOpen.AME.MemorySectionType`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `MemorySection`

  Parameters: | memorySection (`NXOpen.AME.MemorySectionType`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SelectedUDTFromLibrary

`PlcSymbolBuilder.``SelectedUDTFromLibrary`

  Returns the library UDT selection

  `-------------------------------------`

  Getter Method

  Signature `SelectedUDTFromLibrary`

  Returns: |
  Return type: | `NXOpen.Tooling.SelectReuseLibraryItemBuilder`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SelectionParentObject

`PlcSymbolBuilder.``SelectionParentObject`

  Returns the selection ParentObject (parent of the plc symbol)

  `-------------------------------------`

  Getter Method

  Signature `SelectionParentObject`

  Returns: |
  Return type: | `NXOpen.AME.SelectAMEBaseNode`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SymbolName

`PlcSymbolBuilder.``SymbolName`

  Returns or sets the string symbol name

  `-------------------------------------`

  Getter Method

  Signature `SymbolName`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `SymbolName`

  Parameters: | symbolName (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## UdtByName

`PlcSymbolBuilder.``UdtByName`

  Returns or sets the string udt by name data type

  `-------------------------------------`

  Getter Method

  Signature `UdtByName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `UdtByName`

  Parameters: | udtByName (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## UdtFromProject

`PlcSymbolBuilder.``UdtFromProject`

  Returns the project UDT selection

  `-------------------------------------`

  Getter Method

  Signature `UdtFromProject`

  Returns: |
  Return type: | `NXOpen.AME.SelectAMEBaseNode`

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## GetDataType

`PlcSymbolBuilder.``GetDataType`

  Get data type

  Signature `GetDataType()`

  Returns: |
  Return type: | `NXOpen.AME.PlcDataType`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SetDataType

`PlcSymbolBuilder.``SetDataType`

  Set data type

  Signature `SetDataType(dataType)`

  Parameters: | dataType (`NXOpen.AME.PlcDataType`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

`PlcSymbolBuilder.``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.