Represents a Mechatronics::SHMSignalConnectionBuilder
To create a new instance of this class, use Mechatronics::SHMSignalConnectionCollection::CreateSHMSignalConnectionBuilder

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Mechatronics::SHMSignalConnectionBuilder:

Public Types
enum	DataType { DataTypeBool, DataTypeInt, DataTypeDouble }
	Represents the data type. More...

enum	SHMSignalAccessType { SHMSignalAccessTypeRead, SHMSignalAccessTypeWrite }
	Represents the SHM Signal access type. More...

enum	StreamIOType { StreamIOTypeTomcd, StreamIOTypeToshm }
	Represents the mapping data sream direction. More...

Public Member Functions
NXOpen::Mechatronics::SignalAdapter *	AdapterObject ()
	Returns the adapter object.

NXString	ResultName ()
	Returns the mapping result name.

void	SetAdapterObject (NXOpen::Mechatronics::SignalAdapter *adapterObject)
	Sets the adapter object.

void	SetResultName (const NXString &resultName)
	Sets the mapping result name.

void	SetResultName (const char *resultName)
	Sets the mapping result name.

void	SetSHMName (const NXString &shmName)
	Sets the SHM name.

void	SetSHMName (const char *shmName)
	Sets the SHM name.

void	SetSHMSignalAccess (NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccessType shmSignalAccess)
	Sets the SHM access previlege type.

void	SetSHMSignalName (const NXString &shmsignalName)
	Sets the SHM signal name.

void	SetSHMSignalName (const char *shmsignalName)
	Sets the SHM signal name.

void	SetSHMSignalType (NXOpen::Mechatronics::SHMSignalConnectionBuilder::DataType shmSignalType)
	Sets the SHM signal type.

void	SetSignalObject (NXOpen::NXObject *signalObject)
	Sets the signal object.

void	SetStreamIO (NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIOType streamIO)
	Sets the data stream direction.

NXString	SHMName ()
	Returns the SHM name.

NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccessType	SHMSignalAccess ()
	Returns the SHM access previlege type.

NXString	SHMSignalName ()
	Returns the SHM signal name.

NXOpen::Mechatronics::SHMSignalConnectionBuilder::DataType	SHMSignalType ()
	Returns the SHM signal type.

NXOpen::NXObject *	SignalObject ()
	Returns the signal object.

NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIOType	StreamIO ()
	Returns the data stream direction.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Mechatronics::SHMSignalConnectionBuilder
To create a new instance of this class, use Mechatronics::SHMSignalConnectionCollection::CreateSHMSignalConnectionBuilder

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::SHMSignalConnectionBuilder::DataType

Represents the data type.

Enumerator:

DataTypeBool	bool
DataTypeInt	int
DataTypeDouble	double

enum NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccessType

Represents the SHM Signal access type.

Enumerator:

SHMSignalAccessTypeRead	read
SHMSignalAccessTypeWrite	write

enum NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIOType

Represents the mapping data sream direction.

Enumerator:

StreamIOTypeTomcd	write to MCD
StreamIOTypeToshm	write to SHM

Member Function Documentation

NXOpen::Mechatronics::SignalAdapter* NXOpen::Mechatronics::SHMSignalConnectionBuilder::AdapterObject ( )

Returns the adapter object.