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

Represents a NXOpen::Mechatronics::ReadWriteDeviceBuilder . More...

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

Public Types

enum  DeviceType { DeviceTypeReader, DeviceTypeWriter }
 the device types. More...
 
enum  ExecuteMode { ExecuteModeNone, ExecuteModeAlways, ExecuteModeOnceOnly }
 the execute modes. More...
 

Public Member Functions

NXOpen::Mechatronics::ReadWriteDeviceBuilder::DeviceType GetDeviceType ()
 Gets device type. More...
 
NXOpen::Mechatronics::ReadWriteDeviceBuilder::ExecuteMode GetExecuteMode ()
 Gets execute mode. More...
 
NXOpen::Mechatronics::TagFormObjectGetForm ()
 Gets the form NXOpen::Mechatronics::TagFormObject object. More...
 
NXOpen::Mechatronics::TagTableObjectGetTable ()
 Gets the table NXOpen::Mechatronics::TagTableObject object. More...
 
NXString Name ()
 Returns the name. More...
 
NXOpen::Mechatronics::SelectCollisionSensorSensor ()
 Returns the selected sensor NXOpen::Mechatronics::CollisionSensor object. More...
 
void SetDeviceType (NXOpen::Mechatronics::ReadWriteDeviceBuilder::DeviceType type)
 Sets device type. More...
 
void SetExecuteMode (NXOpen::Mechatronics::ReadWriteDeviceBuilder::ExecuteMode mode)
 Sets execute mode. More...
 
void SetForm (NXOpen::Mechatronics::TagFormObject *form)
 Sets the form NXOpen::Mechatronics::TagFormObject object. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetTable (NXOpen::Mechatronics::TagTableObject *table)
 Sets the table NXOpen::Mechatronics::TagTableObject object. 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::ReadWriteDeviceBuilder .


To create a new instance of this class, use NXOpen::Mechatronics::ReadWriteDeviceCollection::CreateReadWriteDeviceBuilder

Created in NX10.0.0.

Member Enumeration Documentation

the device types.

Enumerator
DeviceTypeReader 

Reader.

DeviceTypeWriter 

Writer.

the execute modes.

Enumerator
ExecuteModeNone 

Never execute.

ExecuteModeAlways 

Always execute.

ExecuteModeOnceOnly 

Only execute once.

Member Function Documentation

NXOpen::Mechatronics::ReadWriteDeviceBuilder::DeviceType NXOpen::Mechatronics::ReadWriteDeviceBuilder::GetDeviceType ( )

Gets device type.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Mechatronics::ReadWriteDeviceBuilder::ExecuteMode NXOpen::Mechatronics::ReadWriteDeviceBuilder::GetExecuteMode ( )

Gets execute mode.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Mechatronics::TagFormObject* NXOpen::Mechatronics::ReadWriteDeviceBuilder::GetForm ( )

Gets the form NXOpen::Mechatronics::TagFormObject object.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::Mechatronics::TagTableObject* NXOpen::Mechatronics::ReadWriteDeviceBuilder::GetTable ( )

Gets the table NXOpen::Mechatronics::TagTableObject object.

Returns

Created in NX10.0.0.

License requirements : None
NXString NXOpen::Mechatronics::ReadWriteDeviceBuilder::Name ( )

Returns the name.


Created in NX10.0.0.

License requirements : None

NXOpen::Mechatronics::SelectCollisionSensor* NXOpen::Mechatronics::ReadWriteDeviceBuilder::Sensor ( )

Returns the selected sensor NXOpen::Mechatronics::CollisionSensor object.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::ReadWriteDeviceBuilder::SetDeviceType ( NXOpen::Mechatronics::ReadWriteDeviceBuilder::DeviceType  type)

Sets device type.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typetype
void NXOpen::Mechatronics::ReadWriteDeviceBuilder::SetExecuteMode ( NXOpen::Mechatronics::ReadWriteDeviceBuilder::ExecuteMode  mode)

Sets execute mode.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
modemode
void NXOpen::Mechatronics::ReadWriteDeviceBuilder::SetForm ( NXOpen::Mechatronics::TagFormObject form)

Sets the form NXOpen::Mechatronics::TagFormObject object.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
formform
void NXOpen::Mechatronics::ReadWriteDeviceBuilder::SetName ( const NXString name)

Sets the name.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Sets the name.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
namename
void NXOpen::Mechatronics::ReadWriteDeviceBuilder::SetTable ( NXOpen::Mechatronics::TagTableObject table)

Sets the table NXOpen::Mechatronics::TagTableObject object.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
tabletable

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