NXOpen::Mechatronics::SHMSignalClientBuilder Class Reference

Represents a NXOpen::Mechatronics::SHMSignalClientBuilder builder. More...

Inheritance diagram for NXOpen::Mechatronics::SHMSignalClientBuilder:

Classes
struct	SHMInfo
	Represents SHMInstance info definition structure. More...
struct	SHMSignal
	Represents SHMTag info definition structure. More...

Public Types
enum	EndianType { EndianTypeLittle, EndianTypeBig }
	Represents endian type. More...

Public Member Functions
void	GetSHMInstance (const NXString &instanceName, NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType *eEndianType, NXString *strStatus)
	Get SHM Client Instance Base Information. More...
void	GetSHMInstance (const char *instanceName, NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType *eEndianType, NXString *strStatus)
	Get SHM Client Instance Base Information. More...
std::vector < NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal >	GetSignals (const NXString &configurationName)
	Get SHM Client Infomation. More...
std::vector < NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal >	GetSignals (const char *configurationName)
	Get SHM Client Infomation. More...
void	RefreshRegisteredInstances (std::vector< NXString > &instanceNames)
	Refresh registered SHMSignal instances. More...
NXString	SelectedConfigurationName ()
	Returns. More...
NXOpen::Part *	SelectedConfigurationPart ()
	Returns. More...
void	SetSelectedConfigurationName (const NXString &configurationName)
	Sets. More...
void	SetSelectedConfigurationName (const char *configurationName)
	Sets. More...
void	SetSelectedConfigurationPart (NXOpen::Part *ownerPart)
	Sets. More...
void	SetSHMInstance (const NXString &instanceName, NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType eEndianType, const NXString &strStatus)
	Set SHM Client Instance Base Information. More...
void	SetSHMInstance (const char *instanceName, NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType eEndianType, const char *strStatus)
	Set SHM Client Instance Base Information. More...
void	SetSignals (const NXString &configurationName, const std::vector< NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal > &signalInfo)
	Set SHM Client Signal Infomation. More...
void	SetSignals (const char *configurationName, const std::vector< NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal > &signalInfo)
	Set SHM Client Signal Infomation. 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::SHMSignalClientBuilder builder.

This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType

Represents endian type.

Enumerator
EndianTypeLittle	little endian
EndianTypeBig	big

Member Function Documentation

void NXOpen::Mechatronics::SHMSignalClientBuilder::GetSHMInstance	(	const NXString &	instanceName,
		NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType *	eEndianType,
		NXString *	strStatus
	)

Get SHM Client Instance Base Information.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
eEndianType	eendiantype
strStatus	strstatus

void NXOpen::Mechatronics::SHMSignalClientBuilder::GetSHMInstance	(	const char *	instanceName,
		NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType *	eEndianType,
		NXString *	strStatus
	)

Get SHM Client Instance Base Information.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
eEndianType	eendiantype
strStatus	strstatus

std::vector<NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal> NXOpen::Mechatronics::SHMSignalClientBuilder::GetSignals

(

const NXString &

configurationName

)

Get SHM Client Infomation.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

std::vector<NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal> NXOpen::Mechatronics::SHMSignalClientBuilder::GetSignals

(

const char *

configurationName

)

Get SHM Client Infomation.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

void NXOpen::Mechatronics::SHMSignalClientBuilder::RefreshRegisteredInstances

(

std::vector< NXString > &

instanceNames

)

Refresh registered SHMSignal instances.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceNames

instancenames

NXString NXOpen::Mechatronics::SHMSignalClientBuilder::SelectedConfigurationName

(

)

Returns.

the selected configuration name.

Created in NX12.0.0.

License requirements : None

NXOpen::Part* NXOpen::Mechatronics::SHMSignalClientBuilder::SelectedConfigurationPart

(

)

Returns.

the selected configuration part.

Created in NX12.0.0.

License requirements : None

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSelectedConfigurationName

(

const NXString &

configurationName

)

Sets.

the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSelectedConfigurationName

(

const char *

configurationName

)

Sets.

the selected configuration name.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

configurationname

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSelectedConfigurationPart

(

NXOpen::Part *

ownerPart

)

Sets.

the selected configuration part.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

ownerPart

ownerpart

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSHMInstance	(	const NXString &	instanceName,
		NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType	eEndianType,
		const NXString &	strStatus
	)

Set SHM Client Instance Base Information.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
eEndianType	eendiantype
strStatus	strstatus

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSHMInstance	(	const char *	instanceName,
		NXOpen::Mechatronics::SHMSignalClientBuilder::EndianType	eEndianType,
		const char *	strStatus
	)

Set SHM Client Instance Base Information.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName	instancename
eEndianType	eendiantype
strStatus	strstatus

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSignals	(	const NXString &	configurationName,
		const std::vector< NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal > &	signalInfo
	)

Set SHM Client Signal Infomation.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName	configurationname
signalInfo	Array of signal infomation

void NXOpen::Mechatronics::SHMSignalClientBuilder::SetSignals	(	const char *	configurationName,
		const std::vector< NXOpen::Mechatronics::SHMSignalClientBuilder::SHMSignal > &	signalInfo
	)

Set SHM Client Signal Infomation.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName	configurationname
signalInfo	Array of signal infomation

---

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

• Mechatronics_SHMSignalClientBuilder.hxx