Class to create Functional Tags and assign them to PLC Channels
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcSymbolBuilder
Created in NX11.0.0.
More...
Public Member Functions | |
| NXOpen::AME::PlcDataTypeSource | DataTypeSource () |
| Returns the data type source Created in NX12.0.0. More... | |
| NXString | Description () |
| Returns the string description Created in NX11.0.0. More... | |
| NXOpen::AME::PlcDataType | GetDataType () |
| Get data type. More... | |
| NXString | HWAddress () |
| Returns the string hwaddress Created in NX11.0.0. More... | |
| int | HWAddressOffsetBit () |
| Returns the int hwaddress offset bit Created in NX11.0.0. More... | |
| int | HWAddressOffsetByte () |
| Returns the int hwaddress offset byte Created in NX11.0.0. More... | |
| NXString | Indicator () |
| Returns the string indicator Created in NX12.0.0. More... | |
| NXOpen::AME::MemorySectionType | MemorySection () |
| Returns the enum io type Created in NX11.0.0. More... | |
| NXOpen::Tooling::SelectReuseLibraryItemBuilder * | SelectedUDTFromLibrary () |
| Returns the library UDT selection Created in NX12.0.0. More... | |
| NXOpen::AME::SelectAMEBaseNode * | SelectionParentObject () |
| Returns the selection ParentObject (parent of the plc symbol) Created in NX11.0.0. More... | |
| void | SetDataType (NXOpen::AME::PlcDataType dataType) |
| Set data type Created in NX11.0.0. More... | |
| void | SetDataTypeSource (NXOpen::AME::PlcDataTypeSource dataTypeSource) |
| Sets the data type source Created in NX12.0.0. More... | |
| void | SetDescription (const NXString &description) |
| Sets the string description Created in NX11.0.0. More... | |
| void | SetDescription (const char *description) |
| Sets the string description Created in NX11.0.0. More... | |
| void | SetHWAddress (const NXString &hWAddress) |
| Sets the string hwaddress Created in NX11.0.0. More... | |
| void | SetHWAddress (const char *hWAddress) |
| Sets the string hwaddress Created in NX11.0.0. More... | |
| void | SetHWAddressOffsetBit (int hWAddressOffsetBit) |
| Sets the int hwaddress offset bit Created in NX11.0.0. More... | |
| void | SetHWAddressOffsetByte (int hWAddress) |
| Sets the int hwaddress offset byte Created in NX11.0.0. More... | |
| void | SetIndicator (const NXString &indicator) |
| Sets the string indicator Created in NX12.0.0. More... | |
| void | SetIndicator (const char *indicator) |
| Sets the string indicator Created in NX12.0.0. More... | |
| void | SetMemorySection (NXOpen::AME::MemorySectionType memorySection) |
| Sets the enum io type Created in NX11.0.0. More... | |
| void | SetSymbolName (const NXString &symbolName) |
| Sets the string symbol name Created in NX11.0.0. More... | |
| void | SetSymbolName (const char *symbolName) |
| Sets the string symbol name Created in NX11.0.0. More... | |
| void | SetUdtByName (const NXString &udtByName) |
| Sets the string udt by name data type Created in NX12.0.0. More... | |
| void | SetUdtByName (const char *udtByName) |
| Sets the string udt by name data type Created in NX12.0.0. More... | |
| NXString | SymbolName () |
| Returns the string symbol name Created in NX11.0.0. More... | |
| NXString | UdtByName () |
| Returns the string udt by name data type Created in NX12.0.0. More... | |
| NXOpen::AME::SelectAMEBaseNode * | UdtFromProject () |
| Returns the project UDT selection Created in NX12.0.0. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| 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::NXObject * | GetObject () |
| 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
Class to create Functional Tags and assign them to PLC Channels
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcSymbolBuilder
Created in NX11.0.0.
Member Function Documentation
| NXOpen::AME::PlcDataTypeSource NXOpen::AME::PlcSymbolBuilder::DataTypeSource | ( | ) |
Returns the data type source
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXString NXOpen::AME::PlcSymbolBuilder::Description | ( | ) |
Returns the string description
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXOpen::AME::PlcDataType NXOpen::AME::PlcSymbolBuilder::GetDataType | ( | ) |
Get data type.
- Returns
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXString NXOpen::AME::PlcSymbolBuilder::HWAddress | ( | ) |
Returns the string hwaddress
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| int NXOpen::AME::PlcSymbolBuilder::HWAddressOffsetBit | ( | ) |
Returns the int hwaddress offset bit
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| int NXOpen::AME::PlcSymbolBuilder::HWAddressOffsetByte | ( | ) |
Returns the int hwaddress offset byte
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXString NXOpen::AME::PlcSymbolBuilder::Indicator | ( | ) |
Returns the string indicator
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXOpen::AME::MemorySectionType NXOpen::AME::PlcSymbolBuilder::MemorySection | ( | ) |
Returns the enum io type
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::PlcSymbolBuilder::SelectedUDTFromLibrary | ( | ) |
Returns the library UDT selection
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::PlcSymbolBuilder::SelectionParentObject | ( | ) |
Returns the selection ParentObject (parent of the plc symbol)
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| void NXOpen::AME::PlcSymbolBuilder::SetDataType | ( | NXOpen::AME::PlcDataType | dataType | ) |
Set data type
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
dataType datatype
| void NXOpen::AME::PlcSymbolBuilder::SetDataTypeSource | ( | NXOpen::AME::PlcDataTypeSource | dataTypeSource | ) |
Sets the data type source
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
dataTypeSource datatypesource
| void NXOpen::AME::PlcSymbolBuilder::SetDescription | ( | const NXString & | description | ) |
Sets the string description
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
description description
| void NXOpen::AME::PlcSymbolBuilder::SetDescription | ( | const char * | description | ) |
Sets the string description
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
description description
| void NXOpen::AME::PlcSymbolBuilder::SetHWAddress | ( | const NXString & | hWAddress | ) |
Sets the string hwaddress
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
hWAddress hwaddress
| void NXOpen::AME::PlcSymbolBuilder::SetHWAddress | ( | const char * | hWAddress | ) |
Sets the string hwaddress
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
hWAddress hwaddress
| void NXOpen::AME::PlcSymbolBuilder::SetHWAddressOffsetBit | ( | int | hWAddressOffsetBit | ) |
Sets the int hwaddress offset bit
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
hWAddressOffsetBit hwaddressoffsetbit
| void NXOpen::AME::PlcSymbolBuilder::SetHWAddressOffsetByte | ( | int | hWAddress | ) |
Sets the int hwaddress offset byte
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
hWAddress hwaddress
| void NXOpen::AME::PlcSymbolBuilder::SetIndicator | ( | const NXString & | indicator | ) |
Sets the string indicator
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
indicator indicator
| void NXOpen::AME::PlcSymbolBuilder::SetIndicator | ( | const char * | indicator | ) |
Sets the string indicator
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
indicator indicator
| void NXOpen::AME::PlcSymbolBuilder::SetMemorySection | ( | NXOpen::AME::MemorySectionType | memorySection | ) |
Sets the enum io type
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
memorySection memorysection
| void NXOpen::AME::PlcSymbolBuilder::SetSymbolName | ( | const NXString & | symbolName | ) |
Sets the string symbol name
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
symbolName symbolname
| void NXOpen::AME::PlcSymbolBuilder::SetSymbolName | ( | const char * | symbolName | ) |
Sets the string symbol name
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
symbolName symbolname
| void NXOpen::AME::PlcSymbolBuilder::SetUdtByName | ( | const NXString & | udtByName | ) |
Sets the string udt by name data type
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
udtByName udtbyname
| void NXOpen::AME::PlcSymbolBuilder::SetUdtByName | ( | const char * | udtByName | ) |
Sets the string udt by name data type
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
- Parameters
-
udtByName udtbyname
| NXString NXOpen::AME::PlcSymbolBuilder::SymbolName | ( | ) |
Returns the string symbol name
Created in NX11.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXString NXOpen::AME::PlcSymbolBuilder::UdtByName | ( | ) |
Returns the string udt by name data type
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
| NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::PlcSymbolBuilder::UdtFromProject | ( | ) |
Returns the project UDT selection
Created in NX12.0.0.
License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
The documentation for this class was generated from the following file:
- AME_PlcSymbolBuilder.hxx