NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::AME::PlcVendorSymbolBuilder Class Reference

Represents a Subnet creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcVendorSymbolBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::PlcVendorSymbolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

int BitOffset ()
 Returns the bit
Created in NX12.0.0. More...
 
int ByteOffset ()
 Returns the byte
Created in NX12.0.0. More...
 
NXOpen::AME::PlcDataType DataType ()
 Returns the type
Created in NX12.0.0. More...
 
int EnumDataLength ()
 Returns the EnumDataLength
Created in NX12.0.0. More...
 
NXString Indicator ()
 Returns the Indicator
Created in NX12.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeSelectionChannel ()
 Returns the selection ParentObject (parent of the plc symbol)
Created in NX12.0.0. More...
 
void SetBitOffset (int bitOffset)
 Sets the bit
Created in NX12.0.0. More...
 
void SetByteOffset (int byteOffset)
 Sets the byte
Created in NX12.0.0. More...
 
void SetDataType (NXOpen::AME::PlcDataType type)
 Sets the type
Created in NX12.0.0. More...
 
void SetEnumDataLength (int enum01)
 Sets the EnumDataLength
Created in NX12.0.0. More...
 
void SetIndicator (const NXString &indicator)
 Sets the Indicator
Created in NX12.0.0. More...
 
void SetIndicator (const char *indicator)
 Sets the Indicator
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Represents a Subnet creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcVendorSymbolBuilder

Created in NX12.0.0.


Member Function Documentation

int NXOpen::AME::PlcVendorSymbolBuilder::BitOffset ( )

Returns the bit
Created in NX12.0.0.



License requirements : None

int NXOpen::AME::PlcVendorSymbolBuilder::ByteOffset ( )

Returns the byte
Created in NX12.0.0.



License requirements : None

NXOpen::AME::PlcDataType NXOpen::AME::PlcVendorSymbolBuilder::DataType ( )

Returns the type
Created in NX12.0.0.



License requirements : None

int NXOpen::AME::PlcVendorSymbolBuilder::EnumDataLength ( )

Returns the EnumDataLength
Created in NX12.0.0.



License requirements : None

NXString NXOpen::AME::PlcVendorSymbolBuilder::Indicator ( )

Returns the Indicator
Created in NX12.0.0.



License requirements : None

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::PlcVendorSymbolBuilder::SelectionChannel ( )

Returns the selection ParentObject (parent of the plc symbol)
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PlcVendorSymbolBuilder::SetBitOffset ( int  bitOffset)

Sets the bit
Created in NX12.0.0.



License requirements : None

Parameters
bitOffsetbitoffset
void NXOpen::AME::PlcVendorSymbolBuilder::SetByteOffset ( int  byteOffset)

Sets the byte
Created in NX12.0.0.



License requirements : None

Parameters
byteOffsetbyteoffset
void NXOpen::AME::PlcVendorSymbolBuilder::SetDataType ( NXOpen::AME::PlcDataType  type)

Sets the type
Created in NX12.0.0.



License requirements : None

Parameters
typetype
void NXOpen::AME::PlcVendorSymbolBuilder::SetEnumDataLength ( int  enum01)

Sets the EnumDataLength
Created in NX12.0.0.



License requirements : None

Parameters
enum01enum01
void NXOpen::AME::PlcVendorSymbolBuilder::SetIndicator ( const NXString indicator)

Sets the Indicator
Created in NX12.0.0.



License requirements : None

Parameters
indicatorindicator
void NXOpen::AME::PlcVendorSymbolBuilder::SetIndicator ( const char *  indicator)

Sets the Indicator
Created in NX12.0.0.



License requirements : None

Parameters
indicatorindicator

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.