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

Represents a NXOpen::Mechatronics::ExternalConnectionElementBuilder builder
To create a new instance of this class, use NXOpen::Mechatronics::ExternalConnectionCollection::CreateExternalConnectionElementBuilder

Created in NX8.0.1. More...

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

Public Types

enum  ConditionType {
  ConditionTypeEq, ConditionTypeGt, ConditionTypeLt, ConditionTypeGe,
  ConditionTypeLe, ConditionTypeNe
}
 the condition type. More...
 
enum  DataType { DataTypeUnknown, DataTypeInteger, DataTypeFloat, DataTypeBoolean }
 the data type. More...
 
enum  StreamType { StreamTypeR, StreamTypeW, StreamTypeRw }
 the stream type. More...
 

Public Member Functions

NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionType ConditionOption ()
 Returns the condition type. More...
 
double ConditionValue ()
 Returns the condition value. More...
 
bool Inverse ()
 Returns whether to inverse the logic value. More...
 
double Multiplier ()
 Returns the multiplier. More...
 
double OffsetValue ()
 Returns the offset value. More...
 
NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType PropertyDataType ()
 Returns the data type of physics property. More...
 
int PropertyId ()
 Returns the property ID of physics object. More...
 
void SetConditionOption (NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionType type)
 Sets the condition type. More...
 
void SetConditionValue (double conditionValue)
 Sets the condition value. More...
 
void SetInverse (bool inverse)
 Sets whether to inverse the logic value. More...
 
void SetMultiplier (double multiplier)
 Sets the multiplier. More...
 
void SetOffsetValue (double offset)
 Sets the offset value. More...
 
void SetPropertyDataType (NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType dataType)
 Sets the data type of physics property. More...
 
void SetPropertyId (int propId)
 Sets the property ID of physics object. More...
 
void SetSignalDataType (NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType dataType)
 Sets the data type of signal. More...
 
void SetSignalName (const NXString &name)
 Sets the name of signal. More...
 
void SetSignalName (const char *name)
 Sets the name of signal. More...
 
void SetStreamOption (NXOpen::Mechatronics::ExternalConnectionElementBuilder::StreamType streamType)
 Sets the data stream type. More...
 
NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType SignalDataType ()
 Returns the data type of signal. More...
 
NXString SignalName ()
 Returns the name of signal. More...
 
NXOpen::Mechatronics::ExternalConnectionElementBuilder::StreamType StreamOption ()
 Returns the data stream type. 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::ExternalConnectionElementBuilder builder
To create a new instance of this class, use NXOpen::Mechatronics::ExternalConnectionCollection::CreateExternalConnectionElementBuilder

Created in NX8.0.1.


Member Enumeration Documentation

the condition type.

Enumerator
ConditionTypeEq 

equal

ConditionTypeGt 

greater than

ConditionTypeLt 

less than

ConditionTypeGe 

greater than or equal

ConditionTypeLe 

less than or equal

ConditionTypeNe 

not equal

the data type.

Enumerator
DataTypeUnknown 

unknown

DataTypeInteger 

integer

DataTypeFloat 

float

DataTypeBoolean 

boolean

the stream type.

Enumerator
StreamTypeR 

read

StreamTypeW 

write

StreamTypeRw 

read and write

Member Function Documentation

NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionType NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionOption ( )

Returns the condition type.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

double NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionValue ( )

Returns the condition value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::ExternalConnectionElementBuilder::Inverse ( )

Returns whether to inverse the logic value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

double NXOpen::Mechatronics::ExternalConnectionElementBuilder::Multiplier ( )

Returns the multiplier.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

double NXOpen::Mechatronics::ExternalConnectionElementBuilder::OffsetValue ( )

Returns the offset value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType NXOpen::Mechatronics::ExternalConnectionElementBuilder::PropertyDataType ( )

Returns the data type of physics property.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::ExternalConnectionElementBuilder::PropertyId ( )

Returns the property ID of physics object.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetConditionOption ( NXOpen::Mechatronics::ExternalConnectionElementBuilder::ConditionType  type)

Sets the condition type.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typetype
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetConditionValue ( double  conditionValue)

Sets the condition value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
conditionValueconditionvalue
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetInverse ( bool  inverse)

Sets whether to inverse the logic value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
inverseinverse
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetMultiplier ( double  multiplier)

Sets the multiplier.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
multipliermultiplier
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetOffsetValue ( double  offset)

Sets the offset value.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
offsetoffset
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetPropertyDataType ( NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType  dataType)

Sets the data type of physics property.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
dataTypedatatype
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetPropertyId ( int  propId)

Sets the property ID of physics object.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
propIdpropid
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetSignalDataType ( NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType  dataType)

Sets the data type of signal.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
dataTypedatatype
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetSignalName ( const NXString name)

Sets the name of signal.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetSignalName ( const char *  name)

Sets the name of signal.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ExternalConnectionElementBuilder::SetStreamOption ( NXOpen::Mechatronics::ExternalConnectionElementBuilder::StreamType  streamType)

Sets the data stream type.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
streamTypestreamtype
NXOpen::Mechatronics::ExternalConnectionElementBuilder::DataType NXOpen::Mechatronics::ExternalConnectionElementBuilder::SignalDataType ( )

Returns the data type of signal.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::ExternalConnectionElementBuilder::SignalName ( )

Returns the name of signal.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::ExternalConnectionElementBuilder::StreamType NXOpen::Mechatronics::ExternalConnectionElementBuilder::StreamOption ( )

Returns the data stream type.


Created in NX8.0.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


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