Represents a NXOpen::Mechatronics::SHMSignalConnectionBuilder
To create a new instance of this class, use NXOpen::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	EndianType { EndianTypeLittle, EndianTypeBig }
	Represents the endian 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. More...

NXOpen::Mechatronics::SHMSignalConnectionBuilder::EndianType	Endian ()
	Returns the endian type. More...

NXString	ResultName ()
	Returns the mapping result name. More...

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

void	SetEndian (NXOpen::Mechatronics::SHMSignalConnectionBuilder::EndianType endian)
	Sets the endian type. More...

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

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

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

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

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

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

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

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

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

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

NXString	SHMName ()
	Returns the SHM name. More...

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

NXString	SHMSignalName ()
	Returns the SHM signal name. More...

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

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

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

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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::SHMSignalConnectionBuilder
To create a new instance of this class, use NXOpen::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::EndianType

Represents the endian type.

Enumerator
EndianTypeLittle	little endian
EndianTypeBig	big endian

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.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SHMSignalConnectionBuilder::EndianType NXOpen::Mechatronics::SHMSignalConnectionBuilder::Endian ( )

Returns the endian type.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SHMSignalConnectionBuilder::ResultName ( )

Returns the mapping result name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetAdapterObject ( NXOpen::Mechatronics::SignalAdapter * adapterObject )

Sets the adapter object.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

adapterObject adapterobject

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetEndian ( NXOpen::Mechatronics::SHMSignalConnectionBuilder::EndianType endian )

Sets the endian type.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

endian endian

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetResultName ( const NXString & resultName )

Sets the mapping result name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

resultName resultname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetResultName ( const char * resultName )

Sets the mapping result name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

resultName resultname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMName ( const NXString & shmName )

Sets the SHM name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmName shmname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMName ( const char * shmName )

Sets the SHM name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmName shmname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMSignalAccess ( NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccessType shmSignalAccess )

Sets the SHM access previlege type.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmSignalAccess shmsignalaccess

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMSignalName ( const NXString & shmsignalName )

Sets the SHM signal name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmsignalName shmsignalname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMSignalName ( const char * shmsignalName )

Sets the SHM signal name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmsignalName shmsignalname

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSHMSignalType ( NXOpen::Mechatronics::SHMSignalConnectionBuilder::DataType shmSignalType )

Sets the SHM signal type.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmSignalType shmsignaltype

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetSignalObject ( NXOpen::NXObject * signalObject )

Sets the signal object.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

signalObject signalobject

void NXOpen::Mechatronics::SHMSignalConnectionBuilder::SetStreamIO ( NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIOType streamIO )

Sets the data stream direction.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

streamIO streamio

NXString NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMName ( )

Returns the SHM name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccessType NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalAccess ( )

Returns the SHM access previlege type.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalName ( )

Returns the SHM signal name.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SHMSignalConnectionBuilder::DataType NXOpen::Mechatronics::SHMSignalConnectionBuilder::SHMSignalType ( )

Returns the SHM signal type.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::NXObject* NXOpen::Mechatronics::SHMSignalConnectionBuilder::SignalObject ( )

Returns the signal object.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIOType NXOpen::Mechatronics::SHMSignalConnectionBuilder::StreamIO ( )

Returns the data stream direction.

Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

The documentation for this class was generated from the following file:

Mechatronics_SHMSignalConnectionBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation