SHMSignalProviderBuilder Class

class NXOpen.Mechatronics.SHMSignalProviderBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.SHMSignalProviderBuilder

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

New in version NX12.0.0.

Properties

Property	Description
CreateShm	Returns or sets get the Ceate SHM toggle status.
IsLittleEndian	Returns or sets the endian type.
ShmMutex	Returns or sets ge the SHM Mutex.
ShmName	Returns or sets get the SHM Name.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetSHMSignals	Get SHMProvider Signals Infomation
SetSHMSignals	Set SHMProvider Signals Infomation
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Structs

SHMSignalProviderBuilderSignalInfo_Struct Struct

Represents SHMProviderSignal info definition structure.

Property Detail

CreateShm

SHMSignalProviderBuilder.CreateShm

Returns or sets get the Ceate SHM toggle status.

-------------------------------------

Getter Method

Signature CreateShm

Returns: Return type:bool

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CreateShm

Parameters:createSHM (bool) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

IsLittleEndian

SHMSignalProviderBuilder.IsLittleEndian

Returns or sets the endian type.

-------------------------------------

Getter Method

Signature IsLittleEndian

Returns: Return type:bool

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature IsLittleEndian

Parameters:isLittleEndian (bool) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ShmMutex

SHMSignalProviderBuilder.ShmMutex

Returns or sets ge the SHM Mutex.

-------------------------------------

Getter Method

Signature ShmMutex

Returns: Return type:str

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ShmMutex

Parameters:shmmutex (str) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ShmName

SHMSignalProviderBuilder.ShmName

Returns or sets get the SHM Name.

-------------------------------------

Getter Method

Signature ShmName

Returns: Return type:str

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ShmName

Parameters:name (str) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

GetSHMSignals

SHMSignalProviderBuilder.GetSHMSignals

Get SHMProvider Signals Infomation

Signature GetSHMSignals()

Returns:Array of SignalInfos Return type:list of NXOpen.Mechatronics.SHMSignalProviderBuilderSignalInfo_Struct

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetSHMSignals

SHMSignalProviderBuilder.SetSHMSignals

Set SHMProvider Signals Infomation

Signature SetSHMSignals(signalInfos)

Parameters:signalInfos (list of NXOpen.Mechatronics.SHMSignalProviderBuilderSignalInfo_Struct) – Array of SignalInfos

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

SHMSignalProviderBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.