Properties

Classes

class keysight.ads.de.db.AppProp

Bases: Property

An application specific property.

These properties have an app_type and then arbitrary data. The data can be anything, including a string.

property app_type: str

static create(owner: OwnerT, name: str, app_type: str, value: ndarray | str) → AppProp

set_value_from_string(value: str) → None

property value: ndarray

value_as_string() → str: Return the value as a string (assumes it is a string).

class keysight.ads.de.db.BooleanProp

Bases: Property

static create(owner: OwnerT, name: str, value: int) → BooleanProp

property value: int

class keysight.ads.de.db.DoubleProp

Bases: Property

static create(owner: OwnerT, name: str, value: float) → DoubleProp

property value: float

class keysight.ads.de.db.DoubleRangeProp

Bases: Property

static create(owner: OwnerT, name: str, lower_bound: float, value: float, upper_bound: float) → DoubleRangeProp

property lower_bound: float

set_range(lower_bound: float, value: float, upper_bound: float) → None

property upper_bound: float

property value: float

class keysight.ads.de.db.EnumProp

Bases: Property

An Enum property - holds a string chosen from a list of strings.

static create(owner: OwnerT, name: str, value: str, enums: Sequence[str]) → EnumProp

property enums: list[str]

property value: str

class keysight.ads.de.db.FloatProp

Bases: Property

static create(owner: OwnerT, name: str, value: float) → FloatProp

property value: float

class keysight.ads.de.db.FloatRangeProp

Bases: Property

static create(owner: OwnerT, name: str, lower_bound: float, value: float, upper_bound: float) → FloatRangeProp

property lower_bound: float

set_range(lower_bound: float, value: float, upper_bound: float) → None

property upper_bound: float

property value: float

class keysight.ads.de.db.HierProp

Bases: Property

An hierarchical property - intended to have properties.

static create(owner: OwnerT, name: str) → HierProp

class keysight.ads.de.db.IntProp

Bases: Property

static create(owner: OwnerT, name: str, value: int) → IntProp

property value: int

class keysight.ads.de.db.IntRangeProp

Bases: Property

static create(owner: OwnerT, name: str, lower_bound: int, value: int, upper_bound: int) → IntRangeProp

property lower_bound: int

set_range(lower_bound: int, value: int, upper_bound: int) → None

property upper_bound: int

property value: int

class keysight.ads.de.db.Property

Bases: object

The base class for all properties.

These properties live in a database, typically a design, but can also live in DM data files for Library, Cell, and View.

To add a property to an object, you first choose the class for the Property, then initialize an object on the desired property owner. For example: de.db.StringProp(inst, “name”, “value”)

To delete a property use delete_prop.

delete_prop() → None

find_prop(name: str) → Property | None

static is_app(p: Property) → TypeGuard[AppProp]

static is_boolean(p: Property) → TypeGuard[BooleanProp]

static is_double(p: Property) → TypeGuard[DoubleProp]

static is_double_range(p: Property) → TypeGuard[DoubleRangeProp]

static is_enum(p: Property) → TypeGuard[EnumProp]

static is_float(p: Property) → TypeGuard[FloatProp]

static is_float_range(p: Property) → TypeGuard[FloatRangeProp]

static is_hier(p: Property) → TypeGuard[HierProp]

static is_int(p: Property) → TypeGuard[IntProp]

static is_int_range(p: Property) → TypeGuard[IntRangeProp]

static is_string(p: Property) → TypeGuard[StringProp]

static is_time(p: Property) → TypeGuard[TimeProp]

static is_time_range(p: Property) → TypeGuard[TimeRangeProp]

property name: str

property owner: OwnerT

property props: NamedReadableCollectionAbc[Property]

property type: PropType

property value: str

class keysight.ads.de.db.PropIter

Bases: object

__init__(owner: OwnerT) → None

class keysight.ads.de.db.StringProp

Bases: Property

static create(owner: OwnerT, name: str, value: str) → StringProp

property value: str

class keysight.ads.de.db.TimeProp

Bases: Property

static create(owner: OwnerT, name: str, value: int) → TimeProp

property value: int

class keysight.ads.de.db.TimeRangeProp

Bases: Property

static create(owner: OwnerT, name: str, lower_bound: int, value: int, upper_bound: int) → TimeRangeProp

property lower_bound: int

set_range(lower_bound: int, value: int, upper_bound: int) → None

property upper_bound: int

property value: int

Enumerated Types

class keysight.ads.de.db.PropType

The type of a Property.

INT = <PropType.INT: 166>

INT_RANGE = <PropType.INT_RANGE: 167>

FLOAT = <PropType.FLOAT: 168>

FLOAT_RANGE = <PropType.FLOAT_RANGE: 169>

STRING = <PropType.STRING: 170>

APP = <PropType.APP: 171>

DOUBLE = <PropType.DOUBLE: 172>

DOUBLE_RANGE = <PropType.DOUBLE_RANGE: 173>

BOOLEAN = <PropType.BOOLEAN: 174>

HIER = <PropType.HIER: 175>

TIME = <PropType.TIME: 176>

TIME_RANGE = <PropType.TIME_RANGE: 177>

ENUM = <PropType.ENUM: 178>

On this page