capellambse.metamodel.information package

Objects and relations for information capture and data modelling.

Information objects inheritance tree (taxonomy):

Information object-relations map (ontology):

class capellambse.metamodel.information.Association

Bases: ModelElement

An Association.

members: m.Accessor[Property]

The members of this Association.

navigable_members: m.Accessor[Property]

The navigable members of this Association.

property roles: ElementList[Property]

class capellambse.metamodel.information.Class

Bases: ModelElement

A Class.

generalizations

The generalizations of this Class.

is_abstract

Indicates if class is abstract.

is_final

Indicates if class is final.

is_primitive

Indicates if class is primitive.

owned_properties

The owned properties of this Class.

property properties: ElementList[Property]

Return all owned and inherited properties.

realizations

The realizations of this Class.

realized_by

The realized by of this Class.

realized_classes

The realized classes of this Class.

state_machines

The state machines of this Class.

sub: m.Accessor

The sub of this Class.

super: m.Accessor[Class]

The super of this Class.

visibility

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

class capellambse.metamodel.information.Collection

Bases: ModelElement

A Collection.

kind

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

sub: m.Accessor

The sub of this Collection.

super: m.Accessor[Collection]

The super of this Collection.

class capellambse.metamodel.information.DataPkg

Bases: ModelElement

A data package that can hold classes.

classes

The classes of this DataPkg.

collections

The collections of this DataPkg.

complex_values

The complex values of this DataPkg.

datatypes

The datatypes of this DataPkg.

enumerations

The enumerations of this DataPkg.

owned_associations

The owned associations of this DataPkg.

packages: m.Accessor

The packages of this DataPkg.

unions

The unions of this DataPkg.

class capellambse.metamodel.information.ExchangeItem

Bases: ModelElement

An item that can be exchanged on an Exchange.

elements

The elements of this ExchangeItem.

exchanges: m.Accessor[m.ModelElement]

The exchanges of this ExchangeItem.

type

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

class capellambse.metamodel.information.ExchangeItemElement

Bases: ModelElement

An ExchangeItemElement (proxy link).

abstract_type

The abstract type of this ExchangeItemElement.

max_card

The max card of this ExchangeItemElement.

min_card

The min card of this ExchangeItemElement.

owner

The owner of this ExchangeItemElement.

class capellambse.metamodel.information.InformationRealization

Bases: TraceableElement

A realization for a Class.

class capellambse.metamodel.information.PortAllocation

Bases: TraceableElement

An exchange between a ComponentPort and FunctionalPort.

class capellambse.metamodel.information.Property

Bases: ModelElement

A Property of a Class.

association

The association of this Property.

default_value

The default value of this Property.

is_abstract

Indicates if property is abstract.

is_derived

Indicates if property is abstract.

is_ordered

Indicates if property is ordered.

is_part_of_key

Indicates if property is part of key.

is_read_only

Indicates if property is read-only.

is_static

Indicates if property is static.

is_unique

Indicates if property is unique.

kind

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

max_card

The max card of this Property.

max_value

The max value of this Property.

min_card

The min card of this Property.

min_value

The min value of this Property.

null_value

The null value of this Property.

type

The type of this Property.

visibility

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

class capellambse.metamodel.information.Union

Bases: Class

A Union.

kind

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

sub: m.Accessor

The sub of this Union.

super: m.Accessor[Class]

The super of this Union.

class capellambse.metamodel.information.Unit

Bases: ModelElement

Unit.

capellambse.metamodel.information.cls

alias of Collection

Submodules

capellambse.metamodel.information.datatype module

class capellambse.metamodel.information.datatype.BooleanType

Bases: DataType

default

The default of this BooleanType.

literals

The literals of this BooleanType.

class capellambse.metamodel.information.datatype.DataType

Bases: ModelElement

is_discrete

Whether or not this data type characterizes a discrete value.

max_inclusive

A POD containing a boolean.

min_inclusive

A POD containing a boolean.

pattern

Textual specification of a constraint associated to this data type.

visibility

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

class capellambse.metamodel.information.datatype.Enumeration

Bases: DataType

An Enumeration.

domain_type

The domain type of this Enumeration.

property literals: ElementList[EnumerationLiteral]

Return all owned and inherited literals.

owned_literals

The owned literals of this Enumeration.

sub: m.Accessor

The sub of this Enumeration.

super: m.Accessor[Enumeration]

The super of this Enumeration.

class capellambse.metamodel.information.datatype.NumericType

Bases: DataType

default_value

The default value of this NumericType.

kind

A POD that can have one of a pretermined set of values.

This works in much the same way as the StringPOD, except that the returned and consumed values are not simple strings, but members of the Enum that was passed into the constructor.

When assigning, this property also accepts the string name of one of the enum members. In either case, the corresponding enum member’s value will be placed in the underlying XML element.

The default constructor argument determines which member will be used if the attribute is missing from the XML. If no default is passed exlicitly, the first declared enum member will be used.

max_value

The max value of this NumericType.

min_value

The min value of this NumericType.

null_value

The null value of this NumericType.

class capellambse.metamodel.information.datatype.PhysicalQuantity

Bases: NumericType

unit

The unit of this PhysicalQuantity.

class capellambse.metamodel.information.datatype.StringType

Bases: DataType

default_value

The default value of this StringType.

max_length

The max length of this StringType.

min_length

The min length of this StringType.

null_value

The null value of this StringType.

capellambse.metamodel.information.datavalue module

class capellambse.metamodel.information.datavalue.ComplexValue

Bases: ModelElement

A Complex Value.

type

The type of this ComplexValue.

value_parts

The value parts of this ComplexValue.

class capellambse.metamodel.information.datavalue.EnumerationLiteral

Bases: ModelElement

owner

The owner of this EnumerationLiteral.

value

The value of this EnumerationLiteral.

class capellambse.metamodel.information.datavalue.EnumerationReference

Bases: ModelElement

type

The type of this EnumerationReference.

value

The value of this EnumerationReference.

class capellambse.metamodel.information.datavalue.LiteralBooleanValue

Bases: ModelElement

A Literal Boolean Value.

value

A POD containing a boolean.

class capellambse.metamodel.information.datavalue.LiteralNumericValue

Bases: LiteralValue

unit

The unit of this LiteralNumericValue.

value

A POD containing arbitrary string data.

class capellambse.metamodel.information.datavalue.LiteralStringValue

Bases: LiteralValue

A Literal String Value.

class capellambse.metamodel.information.datavalue.LiteralValue

Bases: ModelElement

is_abstract

Indicates if property is abstract.

type

The type of this LiteralValue.

value

A POD containing arbitrary string data.

class capellambse.metamodel.information.datavalue.ValuePart

Bases: ModelElement

A Value Part of a Complex Value.

referenced_property

The referenced property of this ValuePart.

value

The value of this ValuePart.