SHMSignalClientBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SHMSignalClientBuilder Class

class `NXOpen.Mechatronics.``SHMSignalClientBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.SHMSignalClientBuilder` builder.

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

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
SelectedConfigurationName | Returns or sets the selected configuration name.
SelectedConfigurationPart | Returns or sets the selected configuration part.
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.
GetSHMInstance | Get SHM Client Instance Base Information
GetSignals | Get SHM Client Infomation
RefreshRegisteredInstances | Refresh registered SHMSignal instances.
SetSHMInstance | Set SHM Client Instance Base Information
SetSignals | Set SHM Client Signal 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.

# Enumerations

SHMSignalClientBuilderEndianType Enumeration | Represents endian type

# Structs

SHMSignalClientBuilderSHMInfo_Struct Struct

> Represents SHMInstance info definition structure.

SHMSignalClientBuilderSHMSignal_Struct Struct

> Represents SHMTag info definition structure.

# Property Detail

## SelectedConfigurationName

`SHMSignalClientBuilder.``SelectedConfigurationName`

  Returns or sets the selected configuration name.

  `-------------------------------------`

  Getter Method

  Signature `SelectedConfigurationName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SelectedConfigurationName`

  Parameters: | configurationName (str) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SelectedConfigurationPart

`SHMSignalClientBuilder.``SelectedConfigurationPart`

  Returns or sets the selected configuration part.

  `-------------------------------------`

  Getter Method

  Signature `SelectedConfigurationPart`

  Returns: |
  Return type: | `NXOpen.Part`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SelectedConfigurationPart`

  Parameters: | ownerPart (`NXOpen.Part`) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## GetSHMInstance

`SHMSignalClientBuilder.``GetSHMInstance`

  Get SHM Client Instance Base Information

  Signature `GetSHMInstance(instanceName)`

  Parameters: | instanceName (str) –
  Returns: | a tuple
  Return type: | A tuple consisting of (eEndianType, strStatus). eEndianType is a `NXOpen.Mechatronics.SHMSignalClientBuilderEndianType`. strStatus is a str.

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## GetSignals

`SHMSignalClientBuilder.``GetSignals`

  Get SHM Client Infomation

  Signature `GetSignals(configurationName)`

  Parameters: | configurationName (str) –
  Returns: |
  Return type: | list of `NXOpen.Mechatronics.SHMSignalClientBuilderSHMSignal_Struct`

  New in version NX12.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## RefreshRegisteredInstances

`SHMSignalClientBuilder.``RefreshRegisteredInstances`

  Refresh registered SHMSignal instances.

  Signature `RefreshRegisteredInstances(instanceNames)`

  Parameters: | instanceNames (list of str) –

  New in version NX12.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetSHMInstance

`SHMSignalClientBuilder.``SetSHMInstance`

  Set SHM Client Instance Base Information

  Signature `SetSHMInstance(instanceName, eEndianType, strStatus)`

  Parameters:

  - instanceName (str) –
  - eEndianType (`NXOpen.Mechatronics.SHMSignalClientBuilderEndianType`) –
  - strStatus (str) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## SetSignals

`SHMSignalClientBuilder.``SetSignals`

  Set SHM Client Signal Infomation

  Signature `SetSignals(configurationName, signalInfo)`

  Parameters:

  - configurationName (str) –
  - signalInfo (list of `NXOpen.Mechatronics.SHMSignalClientBuilderSHMSignal_Struct`) – Array of signal infomation

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

`SHMSignalClientBuilder.``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.