## On this page

  

 

 # custom\_types

 Last update: 16.07.2025 

<a id="custom_types.HidSpecificInputData"></a>

## *class* custom\_types.HidSpecificInputData

An aggregate of input arguments per hid.

<a id="custom_types.HidSpecificInputData.__init__"></a>

#### \_\_init\_\_()

<a id="custom_types.HidSpecificInputData.hid"></a>

#### *property* hid

Hierarchical ID of a design variation, for example, \[0.99.4\]

<a id="custom_types.HidSpecificInputData.input_file"></a>

#### *property* input\_file

Input file.

<a id="custom_types.HidSpecificInputData.input_file_encoding"></a>

#### *property* input\_file\_encoding

Input file encoding.

<a id="custom_types.HidSpecificInputData.input_slot_values"></a>

#### *property* input\_slot\_values

A dict where slot names are keys and items are the slot values.

<a id="custom_types.HidSpecificInputData.osl_variables"></a>

#### *property* osl\_variables

A dict where the keys are optiSLang application specific variables names and items their respective values.

<a id="custom_types.HidSpecificInputData.reference_file"></a>

#### *property* reference\_file

Reference file.

<a id="custom_types.HidSpecificInputData.reference_file_encoding"></a>

#### *property* reference\_file\_encoding

Reference file encoding.

<a id="custom_types.HidSpecificInputData.reference_file_is_relative_to_working_directory"></a>

#### *property* reference\_file\_is\_relative\_to\_working\_directory

Whether “reference\_file” is specified relative to working directory.

<a id="custom_types.HidSpecificInputData.working_dir_hierarchy"></a>

#### *property* working\_dir\_hierarchy

The nodes working directory hierarchy.

<a id="custom_types.HidSpecificInputData.working_directory"></a>

#### *property* working\_directory

String. The nodes working directory.

<a id="custom_types.HidSpecificInputDataIntegrations"></a>

## *class* custom\_types.HidSpecificInputDataIntegrations

<a id="custom_types.HidSpecificInputDataIntegrations.__init__"></a>

#### \_\_init\_\_()

<a id="custom_types.HidSpecificInputDataIntegrations.parameter_values"></a>

#### *property* parameter\_values

Parameter values of a specific HId.

<a id="custom_types.HidSpecificOutputData"></a>

## *class* custom\_types.HidSpecificOutputData

An aggregate of output arguments per hid.

<a id="custom_types.HidSpecificOutputData.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: [HID](id.md#id.HID))

#### \_\_init\_\_(arg2: [HID](id.md#id.HID), arg3: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData))

#### \_\_init\_\_(arg2: [HidSpecificInputData](#custom_types.HidSpecificInputData), arg3: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

\[5\] Create a HidSpecificOutputData instance.

\[6\] Create a HidSpecificOutputData instance.

<a id="custom_types.HidSpecificOutputData.hid"></a>

#### *property* hid

Hierarchical ID of a design variation, for example, \[0.99.4\]

<a id="custom_types.HidSpecificOutputData.output_slot_values"></a>

#### *property* output\_slot\_values

A dict where keys are the output slot names and items are the output slot values.

<a id="custom_types.HidSpecificOutputData.status"></a>

#### *property* status

RunStatus object.

<a id="custom_types.HidSpecificOutputDataIntegrations"></a>

## *class* custom\_types.HidSpecificOutputDataIntegrations

An aggregate of output arguments per hid. Specialization for integration node.

<a id="custom_types.HidSpecificOutputDataIntegrations.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(hid: [HID](id.md#id.HID))

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData))

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict, response\_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict, response\_values: [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)) → object

\[1\] Create a HidSpecificOutputDataIntegrations instance.

\[2\] Create a HidSpecificOutputDataIntegrations instance.

\[3\] Create a HidSpecificOutputDataIntegrations instance.

\[4\] Create a HidSpecificOutputDataIntegrations instance.

\[5\] Create a HidSpecificOutputDataIntegrations instance.

\[6\] Create a HidSpecificOutputDataIntegrations instance.

\[7\] Create a HidSpecificOutputDataIntegrations instance.

\[8\] Create a HidSpecificOutputDataIntegrations instance.

<a id="custom_types.HidSpecificOutputDataIntegrations.adapted_parameter_values"></a>

#### *property* adapted\_parameter\_values

Adapted parameter values of a specific HId.

<a id="custom_types.HidSpecificOutputDataIntegrations.responses"></a>

#### *property* responses

Response values of a specific HId.

<a id="custom_types.HidSpecificOutputDataMop"></a>

## *class* custom\_types.HidSpecificOutputDataMop

An aggregate of output arguments per hid. Specialization for MOP node.

<a id="custom_types.HidSpecificOutputDataMop.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(hid: [HID](id.md#id.HID))

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData))

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus))

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

#### \_\_init\_\_(hid: [HID](id.md#id.HID), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict, resulting\_parameter\_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict) → object

#### \_\_init\_\_(input\_data: [HidSpecificInputData](#custom_types.HidSpecificInputData), run\_status: [RunStatus](#custom_types.RunStatus), output\_slot\_values: dict, resulting\_parameter\_manager: [PyParameterManager](py_os_parameter.md#py_os_parameter.PyParameterManager)) → object

\[1\] Create a HidSpecificOutputDataMop instance.

\[2\] Create a HidSpecificOutputDataMop instance.

\[3\] Create a HidSpecificOutputDataMop instance.

\[4\] Create a HidSpecificOutputDataMop instance.

\[5\] Create a HidSpecificOutputDataMop instance.

\[6\] Create a HidSpecificOutputDataMop instance.

\[7\] Create a HidSpecificOutputDataMop instance.

\[8\] Create a HidSpecificOutputDataMop instance.

<a id="custom_types.HidSpecificOutputDataMop.resulting_parameter_manager"></a>

#### *property* resulting\_parameter\_manager

A class for managing parameters.

<a id="custom_types.InputDefinition"></a>

## *class* custom\_types.InputDefinition

Defining the inputs.

<a id="custom_types.InputDefinition.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry))

<a id="custom_types.InputDefinition.discrete_states"></a>

#### *property* discrete\_states

None or a list of design entries.

<a id="custom_types.InputDefinition.lower_bound"></a>

#### *property* lower\_bound

The lower bound or None.

<a id="custom_types.InputDefinition.mean"></a>

#### *property* mean

The value’s mean or None.

<a id="custom_types.InputDefinition.random_variable_type"></a>

#### *property* random\_variable\_type

The random variable’s type or None.

<a id="custom_types.InputDefinition.standard_deviation"></a>

#### *property* standard\_deviation

The standard deviation or None.

<a id="custom_types.InputDefinition.upper_bound"></a>

#### *property* upper\_bound

The upper bound or None.

<a id="custom_types.OutputDefinition"></a>

## *class* custom\_types.OutputDefinition

Defining the outputs.

<a id="custom_types.OutputDefinition.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: str)

#### \_\_init\_\_(arg2: str, arg3: [PyOSDesignEntry](py_os_design.md#py_os_design.PyOSDesignEntry))

<a id="custom_types.RunStatus"></a>

## *class* custom\_types.RunStatus

An object for documenting success and loggin purpose.

<a id="custom_types.RunStatus.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: bool)

#### \_\_init\_\_(arg2: bool, arg3: str)

<a id="custom_types.RunStatus.message"></a>

#### *property* message

Message for logging purpose.

<a id="custom_types.RunStatus.success"></a>

#### *property* success

Flag for documenting success.

<a id="custom_types.ValueDefinition"></a>

## *class* custom\_types.ValueDefinition

Common base for InputValueDefintion and OutputDefinition

<a id="custom_types.ValueDefinition.__init__"></a>

#### \_\_init\_\_()

Raises an exception This class cannot be instantiated from Python

<a id="custom_types.ValueDefinition.additional_data"></a>

#### *property* additional\_data

Extend the list view of detected inputs and outputs by additional columns where “key” is the column headers and “item” is the corresponding field value. A tree structure for grouping the data can be build here as well: Providing “”entry\_n” : “ANodeLabel””, where n can be 1-9, the current ValueDefinition is assigned to the specified group.

<a id="custom_types.ValueDefinition.name"></a>

#### *property* name

<a id="custom_types.ValueDefinition.value"></a>

#### *property* value