NXOpen::Mechatronics::SHMSignalProviderBuilder Class Reference

Represents a NXOpen::Mechatronics::SHMSignalProviderBuilder
This class is sub-object of another builder, and cannot be directly instantiated. More...

Inheritance diagram for NXOpen::Mechatronics::SHMSignalProviderBuilder:

Classes
struct	SignalInfo
	Represents SHMProviderSignal info definition structure. More...

Public Member Functions
bool	CreateShm ()
	Returns. More...
std::vector < NXOpen::Mechatronics::SHMSignalProviderBuilder::SignalInfo >	GetSHMSignals ()
	Get SHMProvider Signals Infomation. More...
bool	IsLittleEndian ()
	Returns. More...
void	SetCreateShm (bool createSHM)
	Sets. More...
void	SetLittleEndian (bool isLittleEndian)
	Sets. More...
void	SetShmMutex (const NXString &shmmutex)
	Sets. More...
void	SetShmMutex (const char *shmmutex)
	Sets. More...
void	SetShmName (const NXString &name)
	Sets. More...
void	SetShmName (const char *name)
	Sets. More...
void	SetSHMSignals (const std::vector< NXOpen::Mechatronics::SHMSignalProviderBuilder::SignalInfo > &signalInfos)
	Set SHMProvider Signals Infomation. More...
NXString	ShmMutex ()
	Returns. More...
NXString	ShmName ()
	Returns. 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::SHMSignalProviderBuilder
This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX12.0.0.

Member Function Documentation

bool NXOpen::Mechatronics::SHMSignalProviderBuilder::CreateShm

(

)

Returns.

Get the Ceate SHM toggle status.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

std::vector<NXOpen::Mechatronics::SHMSignalProviderBuilder::SignalInfo> NXOpen::Mechatronics::SHMSignalProviderBuilder::GetSHMSignals

(

)

Get SHMProvider Signals Infomation.

Returns

Array of SignalInfos
Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::SHMSignalProviderBuilder::IsLittleEndian

(

)

Returns.

the endian type.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetCreateShm

(

bool

createSHM

)

Sets.

Get the Ceate SHM toggle status.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

createSHM

createshm

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetLittleEndian

(

bool

isLittleEndian

)

Sets.

the endian type.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

isLittleEndian

islittleendian

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetShmMutex

(

const NXString &

shmmutex

)

Sets.

Ge the SHM Mutex.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmmutex

shmmutex

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetShmMutex

(

const char *

shmmutex

)

Sets.

Ge the SHM Mutex.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

shmmutex

shmmutex

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetShmName

(

const NXString &

name

)

Sets.

Get the SHM Name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name

name

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetShmName

(

const char *

name

)

Sets.

Get the SHM Name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name

name

void NXOpen::Mechatronics::SHMSignalProviderBuilder::SetSHMSignals

(

const std::vector< NXOpen::Mechatronics::SHMSignalProviderBuilder::SignalInfo > &

signalInfos

)

Set SHMProvider Signals Infomation.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

signalInfos

Array of SignalInfos

NXString NXOpen::Mechatronics::SHMSignalProviderBuilder::ShmMutex

(

)

Returns.

Ge the SHM Mutex.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::SHMSignalProviderBuilder::ShmName

(

)

Returns.

Get the SHM Name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

---

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

• Mechatronics_SHMSignalProviderBuilder.hxx