NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::SignalAdapterBuilder Class Reference

Represents a NXOpen::Mechatronics::SignalAdapterBuilder . More...

Inheritance diagram for NXOpen::Mechatronics::SignalAdapterBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Classes

struct  ParameterData
 Defines the parameter data. More...
 
struct  SignalData
 Defines the signal data. More...
 

Public Types

enum  DataPortType { DataPortTypeInput, DataPortTypeOutput }
 Represents the data port type. More...
 
enum  DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
 Represents the data type. More...
 

Public Member Functions

std::vector
< NXOpen::Mechatronics::SignalAdapterBuilder::ParameterData
GetParameterData ()
 Gets all parameter data. More...
 
std::vector
< NXOpen::Mechatronics::SignalAdapterBuilder::SignalData
GetSignalData ()
 Gets all signal data. More...
 
int MaxSignalId ()
 Returns the maximum signal id. More...
 
NXString Name ()
 Returns the name. More...
 
void SetMaxSignalId (int maxSignalId)
 Sets the maximum signal id. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetParameterData (const std::vector< NXOpen::Mechatronics::SignalAdapterBuilder::ParameterData > &parameterData)
 Sets all parameter data. More...
 
void SetSignalData (const std::vector< NXOpen::Mechatronics::SignalAdapterBuilder::SignalData > &signalData)
 Sets all signal data. 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 NXOpen::Mechatronics::SignalAdapterBuilder .


To create a new instance of this class, use NXOpen::Mechatronics::SignalAdapterCollection::CreateSignalAdapterBuilder

Created in NX8.5.0.

Member Enumeration Documentation

Represents the data port type.

Enumerator
DataPortTypeInput 

Input.

DataPortTypeOutput 

Output.

Represents the data type.

Enumerator
DataTypeBool 

bool

DataTypeInt 

int

DataTypeDouble 

double

Member Function Documentation

std::vector<NXOpen::Mechatronics::SignalAdapterBuilder::ParameterData> NXOpen::Mechatronics::SignalAdapterBuilder::GetParameterData ( )

Gets all parameter data.

Returns
Array of parameter data
Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
std::vector<NXOpen::Mechatronics::SignalAdapterBuilder::SignalData> NXOpen::Mechatronics::SignalAdapterBuilder::GetSignalData ( )

Gets all signal data.

Returns
Array of signal data
Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
int NXOpen::Mechatronics::SignalAdapterBuilder::MaxSignalId ( )

Returns the maximum signal id.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SignalAdapterBuilder::Name ( )

Returns the name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::SignalAdapterBuilder::SetMaxSignalId ( int  maxSignalId)

Sets the maximum signal id.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
maxSignalIdmaxsignalid
void NXOpen::Mechatronics::SignalAdapterBuilder::SetName ( const NXString name)

Sets the name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::SignalAdapterBuilder::SetName ( const char *  name)

Sets the name.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::SignalAdapterBuilder::SetParameterData ( const std::vector< NXOpen::Mechatronics::SignalAdapterBuilder::ParameterData > &  parameterData)

Sets all parameter data.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
parameterDataArray of parameter data
void NXOpen::Mechatronics::SignalAdapterBuilder::SetSignalData ( const std::vector< NXOpen::Mechatronics::SignalAdapterBuilder::SignalData > &  signalData)

Sets all signal data.


Created in NX8.5.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
signalDataArray of signal data

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