NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::AME::DataTypeBuilder Class Reference

JA class for the data type dialog
This object does not need a creator. More...

Inheritance diagram for NXOpen::AME::DataTypeBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

int DataLength ()
 Returns the int datalength
Created in NX12.0.0. More...
 
NXOpen::AME::PlcDataTypeSource DataTypeSource ()
 Returns the DataTypeSource
Created in NX12.0.0. More...
 
std::vector< NXStringGetPopulatedDataTypes (NXOpen::AME::MemorySectionType sectionType)
 The PopulatedDataTypes
Created in NX12.0.0. More...
 
int SelectedDataTypePosition ()
 Returns the DataType
Created in NX12.0.0. More...
 
NXOpen::Tooling::SelectReuseLibraryItemBuilderSelectedUDTFromLibrary ()
 Returns the library UDT selection
Created in NX12.0.0. More...
 
void SetDataLength (int dataLength)
 Sets the int datalength
Created in NX12.0.0. More...
 
void SetDataTypeSource (NXOpen::AME::PlcDataTypeSource dataTypeSource)
 Sets the DataTypeSource
Created in NX12.0.0. More...
 
void SetSelectedDataTypePosition (int dataTypePos)
 Sets the DataType
Created in NX12.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 UdtByName ()
 Returns the string udt by name data type
Created in NX12.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeUdtFromProject ()
 Returns the project UDT selection
Created in NX12.0.0. 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

JA class for the data type dialog
This object does not need a creator.



Created in NX12.0.0.

Member Function Documentation

int NXOpen::AME::DataTypeBuilder::DataLength ( )

Returns the int datalength
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PlcDataTypeSource NXOpen::AME::DataTypeBuilder::DataTypeSource ( )

Returns the DataTypeSource
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

std::vector<NXString> NXOpen::AME::DataTypeBuilder::GetPopulatedDataTypes ( NXOpen::AME::MemorySectionType  sectionType)

The PopulatedDataTypes
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sectionTypesectiontype
int NXOpen::AME::DataTypeBuilder::SelectedDataTypePosition ( )

Returns the DataType
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Tooling::SelectReuseLibraryItemBuilder* NXOpen::AME::DataTypeBuilder::SelectedUDTFromLibrary ( )

Returns the library UDT selection
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::DataTypeBuilder::SetDataLength ( int  dataLength)

Sets the int datalength
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dataLengthdatalength
void NXOpen::AME::DataTypeBuilder::SetDataTypeSource ( NXOpen::AME::PlcDataTypeSource  dataTypeSource)

Sets the DataTypeSource
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dataTypeSourcedatatypesource
void NXOpen::AME::DataTypeBuilder::SetSelectedDataTypePosition ( int  dataTypePos)

Sets the DataType
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dataTypePosdatatypepos
void NXOpen::AME::DataTypeBuilder::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
udtByNameudtbyname
void NXOpen::AME::DataTypeBuilder::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
udtByNameudtbyname
NXString NXOpen::AME::DataTypeBuilder::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::DataTypeBuilder::UdtFromProject ( )

Returns the project UDT selection
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

virtual bool NXOpen::AME::DataTypeBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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