phoebusgen.v4.properties package

Submodules

phoebusgen.v4.properties.behavior module

class phoebusgen.v4.properties.behavior.HasActionsRulesAndScripts

Bases: PropertyBase

property actions

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property rules

property scripts

class phoebusgen.v4.properties.behavior.HasAlarmBorder

Bases: PropertyBase

property border_alarm_sensitive

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasArrayIndex

Bases: PropertyBase

property array_index

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasAutoScale

Bases: PropertyBase

property auto_scale

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasBarLength

Bases: PropertyBase

property bar_length

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasButtonMode

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property mode

root: Element

class phoebusgen.v4.properties.behavior.HasColorMode

Bases: PropertyBase

property color_mode

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasConfirmation

Bases: PropertyBase

property confirm_message

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property password

root: Element

property show_confirm_dialog

class phoebusgen.v4.properties.behavior.HasDataWidthAndHeight

Bases: PropertyBase

property data_height

property data_width

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasEditable

Bases: PropertyBase

property editable

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasEnabled

Bases: PropertyBase

property enabled

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasFallback

Bases: PropertyBase

property fallback_color

property fallback_label

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasFallbackSymbol

Bases: PropertyBase

property fallback_symbol

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.behavior.HasIncrement

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property increment

root: Element

class phoebusgen.v4.properties.behavior.HasInteractive

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property interactive

root: Element

class phoebusgen.v4.properties.behavior.HasInterpolation

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property interpolation

root: Element

class phoebusgen.v4.properties.behavior.HasItems

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property items

root: Element

class phoebusgen.v4.properties.behavior.HasLimitsFromPV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property limits_from_pv

root: Element

class phoebusgen.v4.properties.behavior.HasLogScale

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property log_scale

root: Element

class phoebusgen.v4.properties.behavior.HasMinMax

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property maximum

property minimum

root: Element

class phoebusgen.v4.properties.behavior.HasPreserveRatio

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property preserve_ratio

root: Element

class phoebusgen.v4.properties.behavior.HasRunActionsOnMouseClick

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property run_actions_on_mouse_click

class phoebusgen.v4.properties.behavior.HasSelectionValuePV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property selection_value_pv

class phoebusgen.v4.properties.behavior.HasShowLimits

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_limits

class phoebusgen.v4.properties.behavior.HasStates

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property states

class phoebusgen.v4.properties.behavior.HasToolTip

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property tooltip

class phoebusgen.v4.properties.behavior.HasTraces

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property traces

class phoebusgen.v4.properties.behavior.HasUnisignedData

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property unsigned_data

class phoebusgen.v4.properties.behavior.HasWarningLevels

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property level_high

property level_hihi

property level_lolo

property level_low

root: Element

class phoebusgen.v4.properties.behavior.HasWarningLevelsVisibility

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_high

property show_hihi

property show_lolo

property show_low

class phoebusgen.v4.properties.behavior.HasWrapWords

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property wrap_words

class phoebusgen.v4.properties.behavior.HasXAxis

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property x_axis

class phoebusgen.v4.properties.behavior.HasYAxes

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property y_axes

class phoebusgen.v4.properties.behavior.HasYAxis

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property y_axis

phoebusgen.v4.properties.display module

class phoebusgen.v4.properties.display.HasAngle

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property start_angle

property total_angle

class phoebusgen.v4.properties.display.HasArrows

Bases: PropertyBase

property arrow_length

property arrows

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasAutoSize

Bases: PropertyBase

property auto_size

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasBackgroundColor

Bases: PropertyBase

property background_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasButtonsOnLeft

Bases: PropertyBase

property buttons_on_left

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasColorBar

Bases: PropertyBase

property color_bar

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasColorMap

Bases: PropertyBase

property color_map

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasColumns

Bases: PropertyBase

property columns

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasCorners

Bases: PropertyBase

property corner_height

property corner_width

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasDeselectedColor

Bases: PropertyBase

property deselected_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasDisconnectOverlayColor

Bases: PropertyBase

property disconnect_overlay_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasEmptyColor

Bases: PropertyBase

property empty_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasEnableGradient

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property is_gradient_enabled

root: Element

class phoebusgen.v4.properties.display.HasErrPV

Bases: PropertyBase

property err_pv

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasFillColor

Bases: PropertyBase

property fill_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasFont

Bases: PropertyBase

property font

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasForegroundColor

Bases: PropertyBase

property foreground_color

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasFormat

Bases: PropertyBase

property format

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasGap

Bases: PropertyBase

property gap

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasGroupName

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property group_name

root: Element

class phoebusgen.v4.properties.display.HasGroupStyle

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property style

class phoebusgen.v4.properties.display.HasHeightPV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property height_pv

root: Element

class phoebusgen.v4.properties.display.HasHighlightActiveRegion

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property is_highlighting_of_active_regions_enabled

root: Element

class phoebusgen.v4.properties.display.HasHorizontal

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property horizontal

root: Element

class phoebusgen.v4.properties.display.HasHorizontalAlignment

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property horizontal_alignment

root: Element

class phoebusgen.v4.properties.display.HasInitialIndex

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property initial_index

root: Element

class phoebusgen.v4.properties.display.HasItemsFromPV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property items_from_pv

root: Element

class phoebusgen.v4.properties.display.HasKnobAndNeedleSize

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property knob_size

property needle_width

root: Element

class phoebusgen.v4.properties.display.HasLabelFont

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property label_font

root: Element

class phoebusgen.v4.properties.display.HasLabels

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property labels

root: Element

class phoebusgen.v4.properties.display.HasLabelsFromPV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property labels_from_pv

root: Element

class phoebusgen.v4.properties.display.HasLineColor

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property line_color

root: Element

class phoebusgen.v4.properties.display.HasLineStyle

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property line_style

root: Element

class phoebusgen.v4.properties.display.HasLineWidth

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property line_width

root: Element

class phoebusgen.v4.properties.display.HasLinearMeterColors

Bases: PropertyBase

property colors

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.display.HasMajorTicksPixelDist

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property major_ticks_pixel_dist

root: Element

class phoebusgen.v4.properties.display.HasMultiLine

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property multi_line

root: Element

class phoebusgen.v4.properties.display.HasNumBits

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property num_bits

root: Element

class phoebusgen.v4.properties.display.HasOnOffColors

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property off_color

property on_color

root: Element

class phoebusgen.v4.properties.display.HasOnOffImages

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property off_image

property on_image

root: Element

class phoebusgen.v4.properties.display.HasOnOffLabels

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property off_label

property on_label

root: Element

class phoebusgen.v4.properties.display.HasOpacity

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property opacity

root: Element

class phoebusgen.v4.properties.display.HasPointSize

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property point_size

root: Element

class phoebusgen.v4.properties.display.HasPoints

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property points

root: Element

class phoebusgen.v4.properties.display.HasPrecision

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property precision

root: Element

class phoebusgen.v4.properties.display.HasResizeBehavior

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property resize_behavior

root: Element

class phoebusgen.v4.properties.display.HasReverseBits

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property reverse_bits

root: Element

class phoebusgen.v4.properties.display.HasRotation

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property rotation

class phoebusgen.v4.properties.display.HasRotationStep

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property rotation_step

class phoebusgen.v4.properties.display.HasScaleFont

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property scale_font

class phoebusgen.v4.properties.display.HasScaleFormat

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property scale_format

class phoebusgen.v4.properties.display.HasScaleVisible

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property scale_visible

class phoebusgen.v4.properties.display.HasSelectedColor

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property selected_color

class phoebusgen.v4.properties.display.HasSelectionValuePV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property selection_value_pv

class phoebusgen.v4.properties.display.HasShowGrid

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_grid

class phoebusgen.v4.properties.display.HasShowIndex

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_index

class phoebusgen.v4.properties.display.HasShowLED

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_led

class phoebusgen.v4.properties.display.HasShowLegend

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_legend

class phoebusgen.v4.properties.display.HasShowLimits

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_limits

class phoebusgen.v4.properties.display.HasShowMinorTicks

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_minor_ticks

class phoebusgen.v4.properties.display.HasShowScale

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_scale

class phoebusgen.v4.properties.display.HasShowToolbar

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_toolbar

class phoebusgen.v4.properties.display.HasShowUnits

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_units

class phoebusgen.v4.properties.display.HasShowValue

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_value

class phoebusgen.v4.properties.display.HasShowValueTip

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property show_value_tip

class phoebusgen.v4.properties.display.HasSquare

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property square

class phoebusgen.v4.properties.display.HasStartBit

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property start_bit

class phoebusgen.v4.properties.display.HasStatusColors

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property major_warning_color

property minor_warning_color

property normal_status_color

root: Element

class phoebusgen.v4.properties.display.HasStretchToFit

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property stretch_to_fit

class phoebusgen.v4.properties.display.HasTabActiveHeightDirection

Bases: PropertyBase

property active_tab

property direction

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property tab_height

class phoebusgen.v4.properties.display.HasText

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property text

class phoebusgen.v4.properties.display.HasTimeRange

Bases: PropertyBase

property end

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property start

class phoebusgen.v4.properties.display.HasTitle

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property title

class phoebusgen.v4.properties.display.HasTitleFont

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property title_font

class phoebusgen.v4.properties.display.HasTransparent

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property transparent

class phoebusgen.v4.properties.display.HasVerticalAlignment

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property vertical_alignment

class phoebusgen.v4.properties.display.HasVisible

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property visible

class phoebusgen.v4.properties.display.HasWrapCount

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property wrap_count

class phoebusgen.v4.properties.display.HasWrapWords

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property wrap_words

phoebusgen.v4.properties.misc module

class phoebusgen.v4.properties.misc.HasBorder

Bases: PropertyBase

property border_color

property border_width

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.misc.HasCursor

Bases: PropertyBase

property cursor_crosshair

property cursor_info_pv

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property x_pv

property y_pv

class phoebusgen.v4.properties.misc.HasGrid

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property grid_color

property grid_step_x

property grid_step_y

property grid_visible

root: Element

class phoebusgen.v4.properties.misc.HasKnobAndNeedleColor

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property knob_color

property needle_color

root: Element

class phoebusgen.v4.properties.misc.HasMarkers

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property markers

root: Element

class phoebusgen.v4.properties.misc.HasROIs

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property rois

root: Element

class phoebusgen.v4.properties.misc.HasSelectRows

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property select_rows

class phoebusgen.v4.properties.misc.HasSelectionPV

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property selection_pv

phoebusgen.v4.properties.position module

class phoebusgen.v4.properties.position.HasPosition

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property height

root: Element

property width

property x

property y

phoebusgen.v4.properties.property_helpers module

class phoebusgen.v4.properties.property_helpers.PropertyBase

Bases: object

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.property_helpers.PropertyInfo(type, default_value)

Bases: object

default_value: TypeVar(PropertyTypeT, bound= Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression])

type: Type[TypeVar(PropertyTypeT, bound= Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression])]

class phoebusgen.v4.properties.property_helpers.PropertyMetaclass(name, bases, attrs)

Bases: type

mro()

Return a type’s method resolution order.

phoebusgen.v4.properties.types module

class phoebusgen.v4.properties.types.Action(description='')

Bases: ObservableDataclass

description: str = ''

classmethod fields()

class phoebusgen.v4.properties.types.ArrowTypes(value)

Bases: str, Enum

An enumeration.

BOTH = 'Both'

FROM = 'From'

NONE = 'None'

TO = 'To'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.Axis(visible=True, title='', minimum=0.0, maximum=10.0, on_right=False, autoscale=True, log_scale=False, show_grid=True, title_font=<factory>, scale_font=<factory>, color=<factory>)

Bases: ObservableDataclass

autoscale: bool = True

color: Color

classmethod fields()

log_scale: bool = False

maximum: float = 10.0

minimum: float = 0.0

on_right: bool = False

scale_font: Font

show_grid: bool = True

title: str = ''

title_font: Font

visible: bool = True

class phoebusgen.v4.properties.types.ButtonMode(value)

Bases: int, Enum

An enumeration.

PUSH = 1

PUSH_INVERTED = 2

TOGGLE = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Color(color: Tuple[int, int, int] | Tuple[int, int, int, int] | str = None)

Bases: tuple

as_hex()

Return type:

str

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

classmethod is_color(value)

Return type:

bool

class phoebusgen.v4.properties.types.ColorBar(visible=True, bar_size=40, scale_font=<factory>)

Bases: ObservableDataclass

bar_size: int = 40

classmethod fields()

scale_font: Font

visible: bool = True

class phoebusgen.v4.properties.types.ColorMap(value)

Bases: str, Enum

An enumeration.

COLOR_SPECTRUM = 'SPECTRUM'

COOL = 'COOL'

GRAYSCALE = 'GRAY'

HOT = 'HOT'

JET = 'JET'

MAGMA = 'MAGMA'

SHADED = 'SHADED'

VIRIDIS = 'VIRIDIS'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.ColorMode(value)

Bases: int, Enum

An enumeration.

TYPE_3BYTE_BGR = 9

TYPE_4BYTE_ABGR = 10

TYPE_4BYTE_ABGR_PRE = 11

TYPE_BAYER = 2

TYPE_BYTE_BINARY = 12

TYPE_BYTE_GRAY = 13

TYPE_BYTE_INDEXED = 14

TYPE_CUSTOM = 0

TYPE_INT_ARGB = 15

TYPE_INT_ARGB_PRE = 16

TYPE_INT_BGR = 17

TYPE_INT_RGB = 18

TYPE_MONO = 1

TYPE_RGB1 = 3

TYPE_RGB2 = 4

TYPE_RGB3 = 5

TYPE_USHORT_555_RGB = 19

TYPE_USHORT_565_RGB = 20

TYPE_USHORT_GRAY = 21

TYPE_YUV411 = 8

TYPE_YUV422 = 7

TYPE_YUV444 = 6

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Column(name='', width=100, editable=True, options=<factory>)

Bases: ObservableDataclass

editable: bool = True

classmethod fields()

name: str = ''

options: ObservableList[str]

width: int = 100

class phoebusgen.v4.properties.types.CommandAction(description='', command='')

Bases: Action

command: str = ''

description: str = ''

classmethod fields()

class phoebusgen.v4.properties.types.EmbeddedScript(file=None, pv_names=<factory>, text='')

Bases: Script

classmethod fields()

file: EmbeddedScriptType = None

pv_names: ObservableList[str]

text: str = ''

class phoebusgen.v4.properties.types.EmbeddedScriptType(value)

Bases: str, Enum

An enumeration.

JAVASCRIPT = 'EmbeddedJS'

PYTHON = 'EmbeddedPy'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.ExecuteAction(description='', script=<factory>)

Bases: Action

description: str = ''

classmethod fields()

script: Script

class phoebusgen.v4.properties.types.FileComponent(value)

Bases: int, Enum

An enumeration.

BASE_NAME = 3

DIRECTORY = 1

FULL_PATH = 0

NAME_AND_EXTENSION = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Font(family='Liberation Sans', size=14, style=FontStyle.REGULAR)

Bases: ObservableDataclass

family: str = 'Liberation Sans'

classmethod fields()

size: int = 14

style: FontStyle = 'REGULAR'

class phoebusgen.v4.properties.types.FontStyle(value)

Bases: str, Enum

An enumeration.

BOLD = 'BOLD'

BOLD_AND_ITALIC = 'BOLD_ITALIC'

ITALIC = 'ITALIC'

REGULAR = 'REGULAR'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.Format(value)

Bases: int, Enum

An enumeration.

BINARY = 9

COMPACT = 4

DECIMAL = 1

DEFAULT = 0

ENGINEERING = 2

HEXADECIMAL = 3

SEXAGESIMAL_DMS_360D_RAD = 8

SEXAGESIMAL_HH_MM_SS = 6

SEXAGESIMAL_HMS_24H_RAD = 7

STRING = 5

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.GroupStyle(value)

Bases: int, Enum

An enumeration.

GROUP_BOX = 0

LINE = 2

NONE = 3

TITLE_BAR = 1

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.HorizontalAlignment(value)

Bases: int, Enum

An enumeration.

CENTER = 1

LEFT = 0

RIGHT = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Instance(macros=<factory>)

Bases: ObservableDataclass

classmethod fields()

macros: ObservableDict

class phoebusgen.v4.properties.types.InterpolationType(value)

Bases: int, Enum

An enumeration.

AUTOMATIC = 2

INTERPOLATE = 1

NONE = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.LabelClass(value)

Bases: str, Enum

An enumeration.

COMMENT = 'COMMENT'

DEFAULT = 'DEFAULT'

LABEL = 'Label'

LABEL_1 = 'Label_1'

LABEL_2 = 'Label_2'

SECTION = 'SECTION'

TITLE = 'TITLE'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.LineStyle(value)

Bases: int, Enum

An enumeration.

DASHED = 1

DASH_DOT = 3

DASH_DOT_DOT = 4

DOT = 2

SOLID = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.LinearMeterColors(foreground_color=<factory>, background_color=<factory>, needle_color=<factory>, knob_color=<factory>, normal_status_color=<factory>, minor_warning_color=<factory>, major_warning_color=<factory>, is_gradient_enabled=False, is_highlighting_of_active_regions_enabled=True)

Bases: ObservableDataclass

Linear meter widget combines all colors into special XML element, so needs to be its own dataclass

background_color: Color

classmethod fields()

foreground_color: Color

is_gradient_enabled: bool = False

is_highlighting_of_active_regions_enabled: bool = True

knob_color: Color

major_warning_color: Color

minor_warning_color: Color

needle_color: Color

normal_status_color: Color

class phoebusgen.v4.properties.types.Marker(pv_name='', color=<factory>, interactive=True)

Bases: ObservableDataclass

color: Color

classmethod fields()

interactive: bool = True

pv_name: str = ''

class phoebusgen.v4.properties.types.NavTab(name='', file=None, macros=<factory>, group_name='')

Bases: ObservableDataclass

classmethod fields()

file: Optional[Path] = None

group_name: str = ''

macros: ObservableDict

name: str = ''

class phoebusgen.v4.properties.types.ObservableDataclass

Bases: object

classmethod fields()

class phoebusgen.v4.properties.types.ObservableDict(*args, **kwargs)

Bases: MutableMapping

clear() → None.  Remove all items from D.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

class phoebusgen.v4.properties.types.ObservableList(*args, **kwargs)

Bases: MutableSequence, Generic[ValidListTypeT]

append(value)

S.append(value) – append value to the end of the sequence

clear() → None -- remove all items from S

count(value) → integer -- return number of occurrences of value

extend(values)

S.extend(iterable) – extend sequence by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value)

S.insert(index, value) – insert value before index

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

class phoebusgen.v4.properties.types.OpenDisplayAction(description='', file=None, target=OpenDisplayTarget.REPLACE, macros=<factory>)

Bases: Action

description: str = ''

classmethod fields()

file: Optional[Path] = None

macros: ObservableDict

target: OpenDisplayTarget = 'replace'

class phoebusgen.v4.properties.types.OpenDisplayTarget(value)

Bases: str, Enum

An enumeration.

NEW_TAB = 'tab'

NEW_WINDOW = 'window'

REPLACE = 'replace'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.types.OpenFileAction(description='', file=None)

Bases: Action

description: str = ''

classmethod fields()

file: Optional[Path] = None

class phoebusgen.v4.properties.types.OpenWebpageAction(description='', url='')

Bases: Action

description: str = ''

classmethod fields()

url: str = ''

class phoebusgen.v4.properties.types.Point(x=0.0, y=0.0)

Bases: ObservableDataclass

classmethod fields()

x: float = 0.0

y: float = 0.0

class phoebusgen.v4.properties.types.PointType(value)

Bases: int, Enum

An enumeration.

CIRCLES = 2

DIAMONDS = 3

NONE = 0

SQUARES = 1

TRIANGLES = 5

X = 4

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.ROI(name='', color=<factory>, visible=True, interactive=True, x_pv='', y_pv='', width_pv='', height_pv='', file=None)

Bases: ObservableDataclass

color: Color

classmethod fields()

file: Optional[Path] = None

height_pv: str = ''

interactive: bool = True

name: str = ''

visible: bool = True

width_pv: str = ''

x_pv: str = ''

y_pv: str = ''

class phoebusgen.v4.properties.types.ResizeBehavior(value)

Bases: int, Enum

An enumeration.

CROP_CONTENT = 4

NO_RESIZE = 0

SIZE_CONTENT_TO_FIT_WIDGET = 1

SIZE_WIDGET_TO_MATCH_CONTENT = 2

STRETCH_CONTENT_TO_FIT_WIDGET = 3

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.RotationStep(value)

Bases: int, Enum

An enumeration.

NEGATIVE_NINETY = 3

NINETY = 1

ONE_HUNDRED_EIGHTY = 2

ZERO = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Rule(name='New Rule', prop_id='name', expressions=<factory>, pv_names=<factory>, out_exp=False)

Bases: ObservableDataclass

expressions: ObservableList[RuleExpression]

classmethod fields()

name: str = 'New Rule'

out_exp: bool = False

prop_id: str = 'name'

pv_names: ObservableDict

class phoebusgen.v4.properties.types.RuleExpression(bool_exp='', value=None, value_as_expression=False)

Bases: ObservableDataclass

bool_exp: str = ''

classmethod fields()

value: Optional[TypeVar(ValidListTypeT, bound= Union[int, float, str, bool, Enum, ObservableDataclass])] = None

value_as_expression: bool = False

class phoebusgen.v4.properties.types.RulePvName(name='', trigger=True)

Bases: ObservableDataclass

classmethod fields()

name: str = ''

trigger: bool = True

class phoebusgen.v4.properties.types.Script(file=None, pv_names=<factory>)

Bases: ObservableDataclass

classmethod fields()

file: Optional[Path] = None

pv_names: ObservableList[str]

class phoebusgen.v4.properties.types.State(value=0, label='', color=<factory>)

Bases: ObservableDataclass

color: Color

classmethod fields()

label: str = ''

value: int = 0

class phoebusgen.v4.properties.types.TabDirection(value)

Bases: int, Enum

An enumeration.

HORIZONTAL = 0

VERTICAL = 1

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.Trace(name, x_pv='', y_pv='', error_pv='', y_axis=0, trace_type=TraceType.LINE, color=<factory>, line_width=1, line_style=LineStyle.SOLID, point_type=PointType.NONE, point_size=10, visible=True)

Bases: ObservableDataclass

color: Color

error_pv: str = ''

classmethod fields()

line_style: LineStyle = 0

line_width: int = 1

name: str

point_size: int = 10

point_type: PointType = 0

trace_type: TraceType = 1

visible: bool = True

x_pv: str = ''

y_axis: int = 0

y_pv: str = ''

class phoebusgen.v4.properties.types.TraceType(value)

Bases: int, Enum

An enumeration.

BARS = 5

ERR_BARS = 3

LINE = 1

LINE_ERR_BARS = 4

NONE = 0

STEP = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.VerticalAlignment(value)

Bases: int, Enum

An enumeration.

BOTTOM = 2

MIDDLE = 1

TOP = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.types.WritePvAction(description='', pv_name='', value='')

Bases: Action

description: str = ''

classmethod fields()

pv_name: str = ''

value: str = ''

phoebusgen.v4.properties.widget module

class phoebusgen.v4.properties.widget.HasBit

Bases: PropertyBase

property bit

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.widget.HasFile

Bases: PropertyBase

property file

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.widget.HasFileComponent

Bases: PropertyBase

property file_component

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

class phoebusgen.v4.properties.widget.HasInstances

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property instances

root: Element

class phoebusgen.v4.properties.widget.HasLabel

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property label

root: Element

class phoebusgen.v4.properties.widget.HasMacros

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property macros

root: Element

class phoebusgen.v4.properties.widget.HasName

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property name

root: Element

class phoebusgen.v4.properties.widget.HasNavTabs

Bases: HasTabActiveHeightDirection

property active_tab

property direction

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property tab_height

property tab_spacing

property tab_width

property tabs

class phoebusgen.v4.properties.widget.HasPVName

Bases: HasToolTip

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

property pv_name

root: Element

property tool_tip

property tooltip

class phoebusgen.v4.properties.widget.HasSymbols

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property symbols

class phoebusgen.v4.properties.widget.HasUrl

Bases: PropertyBase

classmethod get_property_classes()

Return a list of all property mixins this class inheritys, including itself if it is a property mixin.

Return type:

List[Type[PropertyBase]]

Returns:

List of property mixin classes

classmethod get_property_names(property_cls=None)

Return a list of property names for a given property class or all property classes if none is specified.

Parameters:

property_cls (Optional[Type[PropertyBase]]) – The property class to get names for, or None to get names for all property classes

Return type:

List[str]

Returns:

List of property names

classmethod get_property_type_by_name(property_name)

Given a property name, return the type of that property by looking it up in the _all_properties dictionary.

Parameters:

property_name (str) – The name of the property to get the type for

Return type:

Type[Union[int, float, str, bool, Tuple, Enum, Color, Font, ObservableDict, ObservableList, ObservableDataclass, Rule, RuleExpression]]

Returns:

The type of the property

root: Element

property url

Module contents

class phoebusgen.v4.properties.Action(description='')

Bases: ObservableDataclass

description: str = ''

classmethod fields()

class phoebusgen.v4.properties.ArrowTypes(value)

Bases: str, Enum

An enumeration.

BOTH = 'Both'

FROM = 'From'

NONE = 'None'

TO = 'To'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.Axis(visible=True, title='', minimum=0.0, maximum=10.0, on_right=False, autoscale=True, log_scale=False, show_grid=True, title_font=<factory>, scale_font=<factory>, color=<factory>)

Bases: ObservableDataclass

autoscale: bool = True

color: Color

classmethod fields()

log_scale: bool = False

maximum: float = 10.0

minimum: float = 0.0

on_right: bool = False

scale_font: Font

show_grid: bool = True

title: str = ''

title_font: Font

visible: bool = True

class phoebusgen.v4.properties.ButtonMode(value)

Bases: int, Enum

An enumeration.

PUSH = 1

PUSH_INVERTED = 2

TOGGLE = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.Color(color: Tuple[int, int, int] | Tuple[int, int, int, int] | str = None)

Bases: tuple

as_hex()

Return type:

str

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

classmethod is_color(value)

Return type:

bool

class phoebusgen.v4.properties.ColorBar(visible=True, bar_size=40, scale_font=<factory>)

Bases: ObservableDataclass

bar_size: int = 40

classmethod fields()

scale_font: Font

visible: bool = True

class phoebusgen.v4.properties.ColorMap(value)

Bases: str, Enum

An enumeration.

COLOR_SPECTRUM = 'SPECTRUM'

COOL = 'COOL'

GRAYSCALE = 'GRAY'

HOT = 'HOT'

JET = 'JET'

MAGMA = 'MAGMA'

SHADED = 'SHADED'

VIRIDIS = 'VIRIDIS'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.ColorMode(value)

Bases: int, Enum

An enumeration.

TYPE_3BYTE_BGR = 9

TYPE_4BYTE_ABGR = 10

TYPE_4BYTE_ABGR_PRE = 11

TYPE_BAYER = 2

TYPE_BYTE_BINARY = 12

TYPE_BYTE_GRAY = 13

TYPE_BYTE_INDEXED = 14

TYPE_CUSTOM = 0

TYPE_INT_ARGB = 15

TYPE_INT_ARGB_PRE = 16

TYPE_INT_BGR = 17

TYPE_INT_RGB = 18

TYPE_MONO = 1

TYPE_RGB1 = 3

TYPE_RGB2 = 4

TYPE_RGB3 = 5

TYPE_USHORT_555_RGB = 19

TYPE_USHORT_565_RGB = 20

TYPE_USHORT_GRAY = 21

TYPE_YUV411 = 8

TYPE_YUV422 = 7

TYPE_YUV444 = 6

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.CommandAction(description='', command='')

Bases: Action

command: str = ''

description: str = ''

classmethod fields()

class phoebusgen.v4.properties.ExecuteAction(description='', script=<factory>)

Bases: Action

description: str = ''

classmethod fields()

script: Script

class phoebusgen.v4.properties.FileComponent(value)

Bases: int, Enum

An enumeration.

BASE_NAME = 3

DIRECTORY = 1

FULL_PATH = 0

NAME_AND_EXTENSION = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.Font(family='Liberation Sans', size=14, style=FontStyle.REGULAR)

Bases: ObservableDataclass

family: str = 'Liberation Sans'

classmethod fields()

size: int = 14

style: FontStyle = 'REGULAR'

class phoebusgen.v4.properties.FontStyle(value)

Bases: str, Enum

An enumeration.

BOLD = 'BOLD'

BOLD_AND_ITALIC = 'BOLD_ITALIC'

ITALIC = 'ITALIC'

REGULAR = 'REGULAR'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including \n \r \t \f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class phoebusgen.v4.properties.GroupStyle(value)

Bases: int, Enum

An enumeration.

GROUP_BOX = 0

LINE = 2

NONE = 3

TITLE_BAR = 1

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.HorizontalAlignment(value)

Bases: int, Enum

An enumeration.

CENTER = 1

LEFT = 0

RIGHT = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.InterpolationType(value)

Bases: int, Enum

An enumeration.

AUTOMATIC = 2

INTERPOLATE = 1

NONE = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.LineStyle(value)

Bases: int, Enum

An enumeration.

DASHED = 1

DASH_DOT = 3

DASH_DOT_DOT = 4

DOT = 2

SOLID = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.Marker(pv_name='', color=<factory>, interactive=True)

Bases: ObservableDataclass

color: Color

classmethod fields()

interactive: bool = True

pv_name: str = ''

class phoebusgen.v4.properties.ObservableDataclass

Bases: object

classmethod fields()

class phoebusgen.v4.properties.ObservableDict(*args, **kwargs)

Bases: MutableMapping

clear() → None.  Remove all items from D.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

class phoebusgen.v4.properties.ObservableList(*args, **kwargs)

Bases: MutableSequence, Generic[ValidListTypeT]

append(value)

S.append(value) – append value to the end of the sequence

clear() → None -- remove all items from S

count(value) → integer -- return number of occurrences of value

extend(values)

S.extend(iterable) – extend sequence by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value)

S.insert(index, value) – insert value before index

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

class phoebusgen.v4.properties.OpenDisplayAction(description='', file=None, target=OpenDisplayTarget.REPLACE, macros=<factory>)

Bases: Action

description: str = ''

classmethod fields()

file: Optional[Path] = None

macros: ObservableDict

target: OpenDisplayTarget = 'replace'

class phoebusgen.v4.properties.OpenFileAction(description='', file=None)

Bases: Action

description: str = ''

classmethod fields()

file: Optional[Path] = None

class phoebusgen.v4.properties.OpenWebpageAction(description='', url='')

Bases: Action

description: str = ''

classmethod fields()

url: str = ''

class phoebusgen.v4.properties.PointType(value)

Bases: int, Enum

An enumeration.

CIRCLES = 2

DIAMONDS = 3

NONE = 0

SQUARES = 1

TRIANGLES = 5

X = 4

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.ROI(name='', color=<factory>, visible=True, interactive=True, x_pv='', y_pv='', width_pv='', height_pv='', file=None)

Bases: ObservableDataclass

color: Color

classmethod fields()

file: Optional[Path] = None

height_pv: str = ''

interactive: bool = True

name: str = ''

visible: bool = True

width_pv: str = ''

x_pv: str = ''

y_pv: str = ''

class phoebusgen.v4.properties.ResizeBehavior(value)

Bases: int, Enum

An enumeration.

CROP_CONTENT = 4

NO_RESIZE = 0

SIZE_CONTENT_TO_FIT_WIDGET = 1

SIZE_WIDGET_TO_MATCH_CONTENT = 2

STRETCH_CONTENT_TO_FIT_WIDGET = 3

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.RotationStep(value)

Bases: int, Enum

An enumeration.

NEGATIVE_NINETY = 3

NINETY = 1

ONE_HUNDRED_EIGHTY = 2

ZERO = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.Rule(name='New Rule', prop_id='name', expressions=<factory>, pv_names=<factory>, out_exp=False)

Bases: ObservableDataclass

expressions: ObservableList[RuleExpression]

classmethod fields()

name: str = 'New Rule'

out_exp: bool = False

prop_id: str = 'name'

pv_names: ObservableDict

class phoebusgen.v4.properties.RuleExpression(bool_exp='', value=None, value_as_expression=False)

Bases: ObservableDataclass

bool_exp: str = ''

classmethod fields()

value: Optional[TypeVar(ValidListTypeT, bound= Union[int, float, str, bool, Enum, ObservableDataclass])] = None

value_as_expression: bool = False

class phoebusgen.v4.properties.Script(file=None, pv_names=<factory>)

Bases: ObservableDataclass

classmethod fields()

file: Optional[Path] = None

pv_names: ObservableList[str]

class phoebusgen.v4.properties.State(value=0, label='', color=<factory>)

Bases: ObservableDataclass

color: Color

classmethod fields()

label: str = ''

value: int = 0

class phoebusgen.v4.properties.Trace(name, x_pv='', y_pv='', error_pv='', y_axis=0, trace_type=TraceType.LINE, color=<factory>, line_width=1, line_style=LineStyle.SOLID, point_type=PointType.NONE, point_size=10, visible=True)

Bases: ObservableDataclass

color: Color

error_pv: str = ''

classmethod fields()

line_style: LineStyle = 0

line_width: int = 1

name: str

point_size: int = 10

point_type: PointType = 0

trace_type: TraceType = 1

visible: bool = True

x_pv: str = ''

y_axis: int = 0

y_pv: str = ''

class phoebusgen.v4.properties.TraceType(value)

Bases: int, Enum

An enumeration.

BARS = 5

ERR_BARS = 3

LINE = 1

LINE_ERR_BARS = 4

NONE = 0

STEP = 2

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.VerticalAlignment(value)

Bases: int, Enum

An enumeration.

BOTTOM = 2

MIDDLE = 1

TOP = 0

as_integer_ratio()

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

from_bytes(byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Indicates whether two’s complement is used to represent the integer.

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

class phoebusgen.v4.properties.WritePvAction(description='', pv_name='', value='')

Bases: Action

description: str = ''

classmethod fields()

pv_name: str = ''

value: str = ''