caret_analyze.value_objects.callback_group module

class caret_analyze.value_objects.callback_group.CallbackGroupStructValue(callback_group_type: CallbackGroupType, node_name: str, callback_values: tuple[CallbackStructValue, ...], callback_group_name: str)

Bases: ValueObject, Summarizable

Callback group value object.

property callback_group_name: str

Get callback group name.

Returns

str: Callback group name.

property callback_group_type: CallbackGroupType: Get callback_group_type.

Returns

CallbackGroupType

property callback_group_type_name: str: Get callback_group_type name.

Returns

CallbackGroupType name

property callback_names: tuple[str, ...]

Get callback names.

Returns

tuple[str, …]: Callback names which are added to the callback group.

property callbacks: tuple[CallbackStructValue, ...]

Get callbacks.

Returns

tuple[CallbackStructValue, …]: Callbacks which are added to the callback group.

property node_name: str

Get node name.

Returns

str: node name

property summary: Summary

Get summary.

Returns

Summary: summary info.

class caret_analyze.value_objects.callback_group.CallbackGroupType(name: str)

Bases: ValueObject

Callback group type class.

The types of callback groups are as follows:

MUTUALLY_EXCLUSIVE
REENTRANT

MUTUALLY_EXCLUSIVE: CallbackGroupType = <caret_analyze.value_objects.callback_group.CallbackGroupType object>

REENTRANT: CallbackGroupType = <caret_analyze.value_objects.callback_group.CallbackGroupType object>

property type_name: str

Return callback group type name.

Returns

str: type name.

class caret_analyze.value_objects.callback_group.CallbackGroupValue(callback_group_type_name: str, node_name: str, node_id: str, callback_ids: tuple[str, ...], callback_group_id: str, *, callback_group_name: str | None = None)

Bases: ValueObject

Callback group value object.

property callback_group_id: str

Get callback group id.

Returns

str: Callback group id.

property callback_group_name: str | None

Get callback group name.

Returns

str | None: Callback group name.

property callback_group_type: CallbackGroupType: Get callback_group_type.

Returns

CallbackGroupType

property callback_ids: tuple[str, ...]

Get callback ids.

Returns

tuple[str, …]: callback ids added to the callback group.

property node_id: str

Get node id.

Returns

str: Node id.

property node_name: str

Get node name.

Returns

str: Node name which includes the callback group.