SHMSignalConnectionBuilder Class

class NXOpen.Mechatronics.SHMSignalConnectionBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.SHMSignalConnectionBuilder

To create a new instance of this class, use NXOpen.Mechatronics.SHMSignalConnectionCollection.CreateSHMSignalConnectionBuilder()

New in version NX9.0.0.

Properties

Property	Description
AdapterObject	Returns or sets the adapter object.
Endian	Returns or sets the endian type.
ResultName	Returns or sets the mapping result name.
SHMName	Returns or sets the SHM name.
SHMSignalAccess	Returns or sets the SHM access previlege type.
SHMSignalName	Returns or sets the SHM signal name.
SHMSignalType	Returns or sets the SHM signal type.
SignalObject	Returns or sets the signal object.
StreamIO	Returns or sets the data stream direction.
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.
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.

Enumerations

SHMSignalConnectionBuilderDataType Enumeration	Represents the data type.
SHMSignalConnectionBuilderEndianType Enumeration	Represents the endian type.
SHMSignalConnectionBuilderSHMSignalAccessType Enumeration	Represents the SHM Signal access type.
SHMSignalConnectionBuilderStreamIOType Enumeration	Represents the mapping data sream direction.

Property Detail

AdapterObject

SHMSignalConnectionBuilder.AdapterObject

Returns or sets the adapter object.

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

Getter Method

Signature AdapterObject

Returns: Return type:NXOpen.Mechatronics.SignalAdapter

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature AdapterObject

Parameters:adapterObject (NXOpen.Mechatronics.SignalAdapter) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Endian

SHMSignalConnectionBuilder.Endian

Returns or sets the endian type.

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

Getter Method

Signature Endian

Returns: Return type:NXOpen.Mechatronics.SHMSignalConnectionBuilderEndianType

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Endian

Parameters:endian (NXOpen.Mechatronics.SHMSignalConnectionBuilderEndianType) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ResultName

SHMSignalConnectionBuilder.ResultName

Returns or sets the mapping result name.

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

Getter Method

Signature ResultName

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature ResultName

Parameters:resultName (str) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SHMName

SHMSignalConnectionBuilder.SHMName

Returns or sets the SHM name.

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

Getter Method

Signature SHMName

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SHMName

Parameters:shmName (str) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SHMSignalAccess

SHMSignalConnectionBuilder.SHMSignalAccess

Returns or sets the SHM access previlege type.

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

Getter Method

Signature SHMSignalAccess

Returns: Return type:NXOpen.Mechatronics.SHMSignalConnectionBuilderSHMSignalAccessType

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SHMSignalAccess

Parameters:shmSignalAccess (NXOpen.Mechatronics.SHMSignalConnectionBuilderSHMSignalAccessType) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SHMSignalName

SHMSignalConnectionBuilder.SHMSignalName

Returns or sets the SHM signal name.

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

Getter Method

Signature SHMSignalName

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SHMSignalName

Parameters:shmsignalName (str) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SHMSignalType

SHMSignalConnectionBuilder.SHMSignalType

Returns or sets the SHM signal type.

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

Getter Method

Signature SHMSignalType

Returns: Return type:NXOpen.Mechatronics.SHMSignalConnectionBuilderDataType

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SHMSignalType

Parameters:shmSignalType (NXOpen.Mechatronics.SHMSignalConnectionBuilderDataType) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SignalObject

SHMSignalConnectionBuilder.SignalObject

Returns or sets the signal object.

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

Getter Method

Signature SignalObject

Returns: Return type:NXOpen.NXObject

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SignalObject

Parameters:signalObject (NXOpen.NXObject) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StreamIO

SHMSignalConnectionBuilder.StreamIO

Returns or sets the data stream direction.

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

Getter Method

Signature StreamIO

Returns: Return type:NXOpen.Mechatronics.SHMSignalConnectionBuilderStreamIOType

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature StreamIO

Parameters:streamIO (NXOpen.Mechatronics.SHMSignalConnectionBuilderStreamIOType) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

SHMSignalConnectionBuilder.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.