capellambse.extensions.pvmt package¶

Property Value Management extension for py-capellambse.

class capellambse.extensions.pvmt.ManagedDomain¶

Bases: ModelElement

A “domain” in the property value management extension.

__init__(model, parent, xmltag=None, /, **kw)¶

Parameters:

model (MelodyModel)
parent (_Element)
xmltag (str | None)
kw (Any)

Return type:

None

enumeration_property_types¶: The enumeration property types of this ManagedDomain.

classmethod from_model(model, element)¶

Wrap an existing model object.

Parameters:

model (MelodyModel) – The MelodyModel instance
element (_Element) – The XML element to wrap

Returns:

An instance of ModelElement (or a more appropriate subclass, if any) that wraps the given XML element.

Return type:

ModelElement

groups¶: The groups of this ManagedDomain.

types¶: The types of this ManagedDomain.

property version¶

class capellambse.extensions.pvmt.ManagedGroup¶

Bases: ModelElement

A managed group of property values.

applies_to(obj)¶

Determine whether this group applies to a model element.

Return type:: bool
Parameters:: obj (ModelObject)

apply(obj)¶

Apply this group to the model element, and return the applied group.

If the group is not applicable to the passed element, a :class:ScopeError will be raised.

If the group was already applied earlier, that group instance will be returned instead. This makes it safe to always use this method when working with PVMT-managed property value groups.

Return type:: PropertyValueGroup
Parameters:: obj (ModelObject)

description¶: The description of this ManagedGroup.

find_applicable()¶

Find all elements in the model that this group applies to.

Return type:: ElementList

property fullname: str¶

selector¶: The element selector rules for this group.

class capellambse.extensions.pvmt.ObjectPVMT¶

Bases: object

Provides access to managed property values on an element.

Managed property values can be accessed in different ways.

The simplest way is to treat the ‘pvmt’ attribute like a dictionary, and assign and retrieve property values directly with subscripting syntax. To do this, provide the “path” to the property value as ‘domain.group.property’, like this:
```
>>> obj = model.by_uuid("08e02248-504d-4ed8-a295-c7682a614f66")
>>> obj.pvmt["DarkMagic.Power.Max"]
1600
>>> obj.pvmt["DarkMagic.Power.Max"] = 2000
>>> obj.pvmt["DarkMagic.Power.Max"]
2000
```
It’s also possible to retrieve a managed group with the same syntax, by omitting the ‘property’ part of the path. The resulting object can be used like a dictionary to access the property values.
```
>>> power = obj.pvmt["DarkMagic.Power"]
>>> power["Max"]
2000
```