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

Represents a NXOpen::Mechatronics::SignalBuilder builder. More...

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

Classes

struct  Signal
 Represents Signal definition structure. More...
 

Public Types

enum  DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
 Represents the data type. More...
 
enum  ExternalSignalIOType { ExternalSignalIOTypeInput, ExternalSignalIOTypeOutput, ExternalSignalIOTypeInout }
 Represents the external signal IO type. More...
 
enum  IOType { IOTypeInput, IOTypeOutput }
 Represents the IO type. More...
 

Public Member Functions

NXOpen::Mechatronics::SignalBuilder::Signal GetSignalData ()
 Gets signal data. More...
 
NXString Name ()
 Returns. More...
 
void SetName (const NXString &name)
 Sets. More...
 
void SetName (const char *name)
 Sets. More...
 
void SetSignalData (const NXOpen::Mechatronics::SignalBuilder::Signal &signalData)
 Sets 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::SignalBuilder builder.


To create a new instance of this class, use NXOpen::Mechatronics::SignalCollection::CreateSignalBuilder

Created in NX11.0.0.

Member Enumeration Documentation

Represents the data type.

Enumerator
DataTypeBool 

bool

DataTypeInt 

int

DataTypeDouble 

double

Represents the external signal IO type.

Enumerator
ExternalSignalIOTypeInput 

Input.

ExternalSignalIOTypeOutput 

Output.

ExternalSignalIOTypeInout 

Output.

Represents the IO type.

Enumerator
IOTypeInput 

Input.

IOTypeOutput 

Output.

Member Function Documentation

NXOpen::Mechatronics::SignalBuilder::Signal NXOpen::Mechatronics::SignalBuilder::GetSignalData ( )

Gets signal data.

Returns

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXString NXOpen::Mechatronics::SignalBuilder::Name ( )

Returns.

the name.

The Signal name must be unique in the context of assembly and it should be selected from NXOpen::Mechatronics::SymbolTable .


Created in NX11.0.0.

License requirements : None

void NXOpen::Mechatronics::SignalBuilder::SetName ( const NXString name)

Sets.

the name.

The Signal name must be unique in the context of assembly and it should be selected from NXOpen::Mechatronics::SymbolTable .


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Sets.

the name.

The Signal name must be unique in the context of assembly and it should be selected from NXOpen::Mechatronics::SymbolTable .


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::SignalBuilder::SetSignalData ( const NXOpen::Mechatronics::SignalBuilder::Signal signalData)

Sets signal data.


Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
signalDatasignaldata

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