NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.AME.PlcSymbolBuilder Class Reference

Class to create Functional Tags and assign them to PLC Channels More...

Inheritance diagram for NXOpen.AME.PlcSymbolBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe NXOpen.AME.PlcDataType GetDataType ()
 Get data type More...
 
unsafe void SetDataType (NXOpen.AME.PlcDataType dataType)
 Set data type More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.AME.DataTypeBuilder DataTypeComp [get]
 Returns the object data type builder More...
 
unsafe NXOpen.AME.PlcDataTypeSource DataTypeSource [get, set]
 Returns or sets the data type source More...
 
unsafe string Description [get, set]
 Returns or sets the string description More...
 
unsafe string HWAddress [get, set]
 Returns or sets the string hwaddress More...
 
unsafe int HWAddressOffsetBit [get, set]
 Returns or sets the int hwaddress offset bit More...
 
unsafe int HWAddressOffsetByte [get, set]
 Returns or sets the int hwaddress offset byte More...
 
unsafe string Indicator [get, set]
 Returns or sets the string indicator More...
 
unsafe NXOpen.AME.MemorySectionType MemorySection [get, set]
 Returns or sets the enum io type More...
 
unsafe
NXOpen.Tooling.SelectReuseLibraryItemBuilder 
SelectedUDTFromLibrary [get]
 Returns the library UDT selection More...
 
unsafe NXOpen.AME.SelectINodeObject SelectionParentObject [get]
 Returns the selection ParentObject (parent of the plc symbol) More...
 
unsafe string SymbolName [get, set]
 Returns or sets the string symbol name More...
 
unsafe string UdtByName [get, set]
 Returns or sets the string udt by name data type More...
 
unsafe NXOpen.AME.SelectAMEBaseNode UdtFromProject [get]
 Returns the project UDT selection More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

unsafe NXOpen.AME.PlcDataType NXOpen.AME.PlcSymbolBuilder.GetDataType ( )
inline

Get data type

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns
unsafe void NXOpen.AME.PlcSymbolBuilder.SetDataType ( NXOpen.AME.PlcDataType  dataType)
inline

Set data type

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dataType

Property Documentation

unsafe NXOpen.AME.DataTypeBuilder NXOpen.AME.PlcSymbolBuilder.DataTypeComp
get

Returns the object data type builder

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.PlcDataTypeSource NXOpen.AME.PlcSymbolBuilder.DataTypeSource
getset

Returns or sets the data type source

Created in NX12.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcSymbolBuilder.Description
getset

Returns or sets the string description

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcSymbolBuilder.HWAddress
getset

Returns or sets the string hwaddress

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe int NXOpen.AME.PlcSymbolBuilder.HWAddressOffsetBit
getset

Returns or sets the int hwaddress offset bit

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe int NXOpen.AME.PlcSymbolBuilder.HWAddressOffsetByte
getset

Returns or sets the int hwaddress offset byte

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcSymbolBuilder.Indicator
getset

Returns or sets the string indicator

Created in NX12.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.MemorySectionType NXOpen.AME.PlcSymbolBuilder.MemorySection
getset

Returns or sets the enum io type

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.Tooling.SelectReuseLibraryItemBuilder NXOpen.AME.PlcSymbolBuilder.SelectedUDTFromLibrary
get

Returns the library UDT selection

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectINodeObject NXOpen.AME.PlcSymbolBuilder.SelectionParentObject
get

Returns the selection ParentObject (parent of the plc symbol)

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcSymbolBuilder.SymbolName
getset

Returns or sets the string symbol name

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.PlcSymbolBuilder.UdtByName
getset

Returns or sets the string udt by name data type

Created in NX12.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectAMEBaseNode NXOpen.AME.PlcSymbolBuilder.UdtFromProject
get

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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.