Ude Class — NXOpen Python API Reference 12.0.0 documentation

# Ude Class

class `NXOpen.CAM.``Ude`

  Bases: `NXOpen.TaggedObject`

  Represets a User Defined Event

  To create a new instance of this class, use `NXOpen.CAM.UdeSet.CreateUde()`

  New in version NX7.0.0.

# Properties

Property | Description
--- | ---
NumberOfParameters | Returns the number of parameters
OutputLoadTool | Returns or sets the output load tool
Tag | Returns the Tag for this object.
UdeName | Returns or sets the ude name

# Methods

Method | Description
--- | ---
GetParameter | Get the parameter for the specified parameter name
GetParameterNames | Returns the parameter names

# Property Detail

## NumberOfParameters

`Ude.``NumberOfParameters`

  Returns the number of parameters

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

  Getter Method

  Signature `NumberOfParameters`

  Returns: | the number of parameters
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

## OutputLoadTool

`Ude.``OutputLoadTool`

  Returns or sets the output load tool

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

  Getter Method

  Signature `OutputLoadTool`

  Returns: | if output load tool
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputLoadTool`

  Parameters: | loadTool (bool) – output load tool

  New in version NX7.5.0.

  License requirements: None.

## UdeName

`Ude.``UdeName`

  Returns or sets the ude name

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

  Getter Method

  Signature `UdeName`

  Returns: | the name of the ude
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UdeName`

  Parameters: | udeName (str) – the name of the Ude

  New in version NX7.5.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## GetParameter

`Ude.``GetParameter`

  Overloaded method GetParameter

  - `GetParameter(parameterName)`
  - `GetParameter(index)`

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

  Get the parameter for the specified parameter name

  Signature `GetParameter(parameterName)`

  Parameters: | parameterName (str) – the parameter name
  Returns: | the parameter
  Return type: | `NXOpen.CAM.UdeParameter`

  New in version NX7.5.0.

  License requirements: None.

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

  Get the parameter for the specified index

  Signature `GetParameter(index)`

  Parameters: | index (int) – the parameter index
  Returns: | the parameter
  Return type: | `NXOpen.CAM.UdeParameter`

  New in version NX8.0.0.

  License requirements: None.

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

## GetParameterNames

`Ude.``GetParameterNames`

  Returns the parameter names

  Signature `GetParameterNames()`

  Returns: | the names of ude parameters
  Return type: | list of str

  New in version NX9.0.1.

  License requirements: None.