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.
struct	_SHMSignal
	Represents SHMTag info definition structure.
struct	SHMInfo
	Represents SHMInstance info definition structure. More...
struct	SHMSignal
	Represents SHMTag info definition structure. More...

Public Types
enum	EndianType { Little, Big }
	Represents endian type More...

Public Member Functions
unsafe void	RefreshRegisteredInstances (string[] instanceNames)
	Refresh registered SHMSignal instances. More...
unsafe void	SetSignals (string configurationName, NXOpen.Mechatronics.SHMSignalClientBuilder.SHMSignal[] signalInfo)
	Set SHM Client Signal Infomation More...
unsafe NXOpen.Mechatronics.SHMSignalClientBuilder.SHMSignal[]	GetSignals (string configurationName)
	Get SHM Client Infomation More...
unsafe void	SetSHMInstance (string instanceName, NXOpen.Mechatronics.SHMSignalClientBuilder.EndianType eEndianType, string strStatus)
	Set SHM Client Instance Base Information More...
unsafe void	GetSHMInstance (string instanceName, out NXOpen.Mechatronics.SHMSignalClientBuilder.EndianType eEndianType, out string strStatus)
	Get SHM Client Instance Base Information More...
Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...
unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...
unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Properties
unsafe string	SelectedConfigurationName [get, set]
	Returns or sets the selected configuration name. More...
unsafe NXOpen.Part	SelectedConfigurationPart [get, set]
	Returns or sets the selected configuration part. 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
Little	little endian
Big

Member Function Documentation

unsafe void NXOpen.Mechatronics.SHMSignalClientBuilder.GetSHMInstance	(	string	instanceName,
		out NXOpen.Mechatronics.SHMSignalClientBuilder.EndianType	eEndianType,
		out string	strStatus
	)

Get SHM Client Instance Base Information

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName
eEndianType
strStatus

unsafe NXOpen.Mechatronics.SHMSignalClientBuilder.SHMSignal [] NXOpen.Mechatronics.SHMSignalClientBuilder.GetSignals

(

string

configurationName

)

Get SHM Client Infomation

Created in NX12.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

configurationName

Returns

unsafe void NXOpen.Mechatronics.SHMSignalClientBuilder.RefreshRegisteredInstances

(

string[]

instanceNames

)

Refresh registered SHMSignal instances.

Created in NX12.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceNames

unsafe void NXOpen.Mechatronics.SHMSignalClientBuilder.SetSHMInstance	(	string	instanceName,
		NXOpen.Mechatronics.SHMSignalClientBuilder.EndianType	eEndianType,
		string	strStatus
	)

Set SHM Client Instance Base Information

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

instanceName
eEndianType
strStatus

unsafe void NXOpen.Mechatronics.SHMSignalClientBuilder.SetSignals	(	string	configurationName,
		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
signalInfo	Array of signal infomation

Property Documentation

unsafe string NXOpen.Mechatronics.SHMSignalClientBuilder.SelectedConfigurationName

getset

Returns or sets the selected configuration name.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

unsafe NXOpen.Part NXOpen.Mechatronics.SHMSignalClientBuilder.SelectedConfigurationPart

getset

Returns or sets the selected configuration part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

---

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

• dotnet_pool/Mechatronics_SHMSignalClientBuilder.cs