capellambse.model.crosslayer package

Utility classes that are used across all layers.

class capellambse.model.crosslayer.BaseArchitectureLayer

Bases: GenericElement

A template architecture layer.

all_classes

The all classes of this BaseArchitectureLayer.

all_collections

The all collections of this BaseArchitectureLayer.

all_complex_values

The all complex values of this BaseArchitectureLayer.

all_enumerations

The all enumerations of this BaseArchitectureLayer.

all_interfaces

The all interfaces of this BaseArchitectureLayer.

all_module_types

The all module types of this BaseArchitectureLayer.

all_relation_types

The all relation types of this BaseArchitectureLayer.

all_requirement_types

The all requirement types of this BaseArchitectureLayer.

all_requirements

The all requirements of this BaseArchitectureLayer.

all_unions

The all unions of this BaseArchitectureLayer.

data_package

The data package of this BaseArchitectureLayer.

interface_package

The interface package of this BaseArchitectureLayer.

requirement_modules

The requirement modules of this BaseArchitectureLayer.

requirement_types_folders

The requirement types folders of this BaseArchitectureLayer.

Subpackages

• capellambse.model.crosslayer.information package
  • Association
    • Association.members
    • Association.navigable_members
    • Association.roles
  • Class
    • Class.generalizations
    • Class.is_abstract
    • Class.is_final
    • Class.is_primitive
    • Class.owned_properties
    • Class.properties
    • Class.realizations
    • Class.realized_by
    • Class.realized_classes
    • Class.state_machines
    • Class.sub
    • Class.super
    • Class.visibility
  • Collection
    • Collection.kind
    • Collection.sub
    • Collection.super
  • DataPkg
    • DataPkg.classes
    • DataPkg.collections
    • DataPkg.complex_values
    • DataPkg.datatypes
    • DataPkg.enumerations
    • DataPkg.owned_associations
    • DataPkg.packages
    • DataPkg.unions
  • ExchangeItem
    • ExchangeItem.elements
    • ExchangeItem.exchanges
    • ExchangeItem.type
  • ExchangeItemElement
    • ExchangeItemElement.abstract_type
    • ExchangeItemElement.max_card
    • ExchangeItemElement.min_card
    • ExchangeItemElement.owner
  • InformationRealization
  • PortAllocation
  • Property
    • Property.association
    • Property.default_value
    • Property.is_abstract
    • Property.is_derived
    • Property.is_ordered
    • Property.is_part_of_key
    • Property.is_read_only
    • Property.is_static
    • Property.is_unique
    • Property.kind
    • Property.max
    • Property.max_card
    • Property.max_value
    • Property.min
    • Property.min_card
    • Property.min_value
    • Property.null_value
    • Property.type
    • Property.visibility
  • Union
    • Union.kind
    • Union.sub
    • Union.super
  • Unit
  • cls
  • Submodules
  • capellambse.model.crosslayer.information.datatype module
    • BooleanType
      • BooleanType.default
      • BooleanType.literals
    • DataType
      • DataType.is_discrete
      • DataType.max_inclusive
      • DataType.min_inclusive
      • DataType.pattern
      • DataType.visibility
    • Enumeration
      • Enumeration.literals
      • Enumeration.owned_literals
      • Enumeration.sub
      • Enumeration.super
    • NumericType
      • NumericType.default_value
      • NumericType.kind
      • NumericType.max_value
      • NumericType.min_value
      • NumericType.null_value
    • PhysicalQuantity
      • PhysicalQuantity.unit
    • StringType
      • StringType.default_value
      • StringType.max_length
      • StringType.min_length
      • StringType.null_value
  • capellambse.model.crosslayer.information.datavalue module
    • ComplexValue
      • ComplexValue.type
      • ComplexValue.value_parts
    • EnumerationLiteral
      • EnumerationLiteral.name
      • EnumerationLiteral.owner
      • EnumerationLiteral.value
    • EnumerationReference
      • EnumerationReference.name
      • EnumerationReference.type
      • EnumerationReference.value
    • LiteralBooleanValue
      • LiteralBooleanValue.value
    • LiteralNumericValue
      • LiteralNumericValue.unit
      • LiteralNumericValue.value
    • LiteralStringValue
    • LiteralValue
      • LiteralValue.is_abstract
      • LiteralValue.type
      • LiteralValue.value
    • ValuePart
      • ValuePart.referenced_property
      • ValuePart.value

Submodules

capellambse.model.crosslayer.capellacommon module

Classes handling Mode/State-Machines and related content.

class capellambse.model.crosslayer.capellacommon.AbstractStateMode

Bases: GenericElement

Common code for states and modes.

realized_states

The realized states of this AbstractStateMode.

regions

The regions of this AbstractStateMode.

class capellambse.model.crosslayer.capellacommon.DeepHistoryPseudoState

Bases: AbstractStateMode

A deep history pseudo state.

realizing_states

The realizing states of this DeepHistoryPseudoState.

class capellambse.model.crosslayer.capellacommon.FinalState

Bases: AbstractStateMode

A final state.

realizing_states

The realizing states of this FinalState.

class capellambse.model.crosslayer.capellacommon.ForkPseudoState

Bases: AbstractStateMode

A fork pseudo state.

realizing_states

The realizing states of this ForkPseudoState.

class capellambse.model.crosslayer.capellacommon.GenericTrace

Bases: TraceableElement

A trace between two elements.

property name: str

Return the name.

class capellambse.model.crosslayer.capellacommon.InitialPseudoState

Bases: AbstractStateMode

An initial pseudo state.

realizing_states

The realizing states of this InitialPseudoState.

class capellambse.model.crosslayer.capellacommon.JoinPseudoState

Bases: AbstractStateMode

A join pseudo state.

realizing_states

The realizing states of this JoinPseudoState.

class capellambse.model.crosslayer.capellacommon.Mode

Bases: AbstractStateMode

A mode.

realizing_states

The realizing states of this Mode.

class capellambse.model.crosslayer.capellacommon.Region

Bases: GenericElement

A region inside a state machine or state/mode.

modes: Accessor

The modes of this Region.

states: Accessor

The states of this Region.

transitions: Accessor

The transitions of this Region.

class capellambse.model.crosslayer.capellacommon.ShallowHistoryPseudoState

Bases: AbstractStateMode

A shallow history pseudo state.

realizing_states

The realizing states of this ShallowHistoryPseudoState.

class capellambse.model.crosslayer.capellacommon.State

Bases: AbstractStateMode

A state.

do_activity

The do activity of this State.

entries

The entries of this State.

exits

The exits of this State.

functions: Accessor

The functions of this State.

realizing_states

The realizing states of this State.

class capellambse.model.crosslayer.capellacommon.StateMachine

Bases: GenericElement

A state machine.

regions

The regions of this StateMachine.

class capellambse.model.crosslayer.capellacommon.StateTransition

Bases: GenericElement

A transition between States or Modes.

destination

The destination of this StateTransition.

effects

The effects of this StateTransition.

guard

The guard of this StateTransition.

source

The source of this StateTransition.

triggers

The triggers of this StateTransition.

class capellambse.model.crosslayer.capellacommon.TerminatePseudoState

Bases: AbstractStateMode

A terminate pseudo state.

realizing_states

The realizing states of this TerminatePseudoState.

capellambse.model.crosslayer.capellacommon.cls

alias of TerminatePseudoState

capellambse.model.crosslayer.capellacore module

class capellambse.model.crosslayer.capellacore.BooleanPropertyValue

Bases: PropertyValue

A boolean property value.

value: c.AttributeProperty | c.AttrProxyAccessor

class capellambse.model.crosslayer.capellacore.Constraint

Bases: GenericElement

A constraint.

constrained_elements

The constrained elements of this Constraint.

specification

The specification of this Constraint.

class capellambse.model.crosslayer.capellacore.EnumerationPropertyLiteral

Bases: GenericElement

A Literal for EnumerationPropertyType.

class capellambse.model.crosslayer.capellacore.EnumerationPropertyType

Bases: GenericElement

An EnumerationPropertyType.

literals

The literals of this EnumerationPropertyType.

class capellambse.model.crosslayer.capellacore.EnumerationPropertyValue

Bases: PropertyValue

An enumeration property value.

type

The type of this EnumerationPropertyValue.

value: c.AttributeProperty | c.AttrProxyAccessor

The value of this EnumerationPropertyValue.

class capellambse.model.crosslayer.capellacore.FloatPropertyValue

Bases: PropertyValue

A floating point property value.

value: c.AttributeProperty | c.AttrProxyAccessor

class capellambse.model.crosslayer.capellacore.Generalization

Bases: GenericElement

A Generalization.

super: c.Accessor

The super of this Generalization.

class capellambse.model.crosslayer.capellacore.IntegerPropertyValue

Bases: PropertyValue

An integer property value.

value: c.AttributeProperty | c.AttrProxyAccessor

class capellambse.model.crosslayer.capellacore.PropertyValue

Bases: GenericElement

Abstract base class for PropertyValues.

enumerations

The enumerations of this PropertyValue.

value: c.AttributeProperty | c.AttrProxyAccessor

class capellambse.model.crosslayer.capellacore.PropertyValueGroup

Bases: GenericElement

A group for PropertyValues.

values

The values of this PropertyValueGroup.

class capellambse.model.crosslayer.capellacore.PropertyValuePkg

Bases: GenericElement

A Package for PropertyValues.

enumeration_property_types

The enumeration property types of this PropertyValuePkg.

groups

The groups of this PropertyValuePkg.

packages

The packages of this PropertyValuePkg.

values

The values of this PropertyValuePkg.

class capellambse.model.crosslayer.capellacore.StringPropertyValue

Bases: PropertyValue

A string property value.

value: c.AttributeProperty | c.AttrProxyAccessor

capellambse.model.crosslayer.cs module

Implementation of objects and relations for Functional Analysis.

Composite Structure objects inheritance tree (taxonomy):

Composite Structure object-relations map (ontology):

class capellambse.model.crosslayer.cs.Component

Bases: GenericElement

A template class for components.

exchanges

The exchanges of this Component.

is_abstract

Boolean flag for an abstract Component

is_actor

Boolean flag for an actor Component

is_human

Boolean flag for a human Component

owner

The owner of this Component.

parts

The parts of this Component.

physical_links

The physical links of this Component.

physical_paths

The physical paths of this Component.

physical_ports

The physical ports of this Component.

ports

The ports of this Component.

realized_components

The realized components of this Component.

realizing_components

The realizing components of this Component.

related_exchanges

The related exchanges of this Component.

state_machines

The state machines of this Component.

class capellambse.model.crosslayer.cs.ComponentRealization

Bases: GenericElement

A realization that links to a component.

class capellambse.model.crosslayer.cs.ExchangeItemAllocation

Bases: GenericElement

An allocation of an ExchangeItem to an Interface.

item

The item of this ExchangeItemAllocation.

class capellambse.model.crosslayer.cs.Interface

Bases: GenericElement

An interface.

exchange_item_allocations

The exchange item allocations of this Interface.

class capellambse.model.crosslayer.cs.InterfacePkg

Bases: GenericElement

A package that can hold interfaces and exchange items.

exchange_items

The exchange items of this InterfacePkg.

interfaces

The interfaces of this InterfacePkg.

packages: Accessor

The packages of this InterfacePkg.

class capellambse.model.crosslayer.cs.Part

Bases: GenericElement

A representation of a physical component.

deployed_parts: Accessor

The deployed parts of this Part.

type

The type of this Part.

class capellambse.model.crosslayer.cs.PhysicalLink

Bases: PhysicalPort

A physical link.

ends

The ends of this PhysicalLink.

exchanges

The exchanges of this PhysicalLink.

linkEnds

The linkEnds of this PhysicalLink.

physical_paths: Accessor

The physical paths of this PhysicalLink.

source

The source of this PhysicalLink.

target

The target of this PhysicalLink.

class capellambse.model.crosslayer.cs.PhysicalPath

Bases: GenericElement

A physical path.

exchanges

The exchanges of this PhysicalPath.

involved_items

The involved items of this PhysicalPath.

property involved_links: ElementList[PhysicalLink]

class capellambse.model.crosslayer.cs.PhysicalPort

Bases: GenericElement

A physical port.

links: Accessor

The links of this PhysicalPort.

owner

The owner of this PhysicalPort.

capellambse.model.crosslayer.fa module

Implementation of objects and relations for Functional Analysis.

Functional Analysis objects inheritance tree (taxonomy):

Functional Analysis object-relations map (ontology):

class capellambse.model.crosslayer.fa.AbstractExchange

Bases: GenericElement

Common code for Exchanges.

source

The source of this AbstractExchange.

source_port

The source port of this AbstractExchange.

target

The target of this AbstractExchange.

target_port

The target port of this AbstractExchange.

class capellambse.model.crosslayer.fa.AbstractFunction

Bases: GenericElement

An AbstractFunction.

available_in_states

The available in states of this AbstractFunction.

class capellambse.model.crosslayer.fa.ComponentExchange

Bases: AbstractExchange

A functional component exchange.

allocated_exchange_items

The allocated exchange items of this ComponentExchange.

allocated_functional_exchanges

The allocated functional exchanges of this ComponentExchange.

allocating_physical_link

The allocating physical link of this ComponentExchange.

property allocating_physical_path: cs.PhysicalPath | None

allocating_physical_paths

The allocating physical paths of this ComponentExchange.

property exchange_items: ElementList[ExchangeItem]

func_exchanges

The func exchanges of this ComponentExchange.

kind

property owner: cs.PhysicalLink | None

realized_component_exchanges

The realized component exchanges of this ComponentExchange.

realizing_component_exchanges

The realizing component exchanges of this ComponentExchange.

class capellambse.model.crosslayer.fa.ComponentPort

Bases: GenericElement

A component port.

direction

exchanges: c.Accessor

The exchanges of this ComponentPort.

owner

The owner of this ComponentPort.

class capellambse.model.crosslayer.fa.ControlNode

Bases: GenericElement

A node with a specific control-kind.

kind

class capellambse.model.crosslayer.fa.Function

Bases: AbstractFunction

Common Code for Function’s.

exchanges: c.Accessor[FunctionalExchange]

The exchanges of this Function.

functions: c.Accessor

inputs

The inputs of this Function.

property is_leaf

kind

outputs

The outputs of this Function.

packages: c.Accessor

realized_functions

The realized functions of this Function.

realizing_functions

The realizing functions of this Function.

related_exchanges: c.Accessor[FunctionalExchange]

The related exchanges of this Function.

class capellambse.model.crosslayer.fa.FunctionInputPort

Bases: FunctionPort

A function input port.

exchange_items

The exchange items of this FunctionInputPort.

exchanges: c.Accessor

The exchanges of this FunctionInputPort.

class capellambse.model.crosslayer.fa.FunctionOutputPort

Bases: FunctionPort

A function output port.

exchange_items

The exchange items of this FunctionOutputPort.

exchanges: c.Accessor

The exchanges of this FunctionOutputPort.

class capellambse.model.crosslayer.fa.FunctionPort

Bases: GenericElement

A function port.

exchanges: c.Accessor

owner

The owner of this FunctionPort.

state_machines

The state machines of this FunctionPort.

class capellambse.model.crosslayer.fa.FunctionRealization

Bases: GenericElement

A realization that links to a function.

class capellambse.model.crosslayer.fa.FunctionalChain

Bases: GenericElement

A functional chain.

control_nodes

The control nodes of this FunctionalChain.

property involved: MixedElementList

involved_chains

The involved chains of this FunctionalChain.

involved_functions

The involved functions of this FunctionalChain.

involved_links

The involved links of this FunctionalChain.

involvements

The involvements of this FunctionalChain.

involving_chains: c.Accessor[FunctionalChain]

The involving chains of this FunctionalChain.

kind

realized_chains

The realized chains of this FunctionalChain.

realizing_chains: c.Accessor[FunctionalChain]

The realizing chains of this FunctionalChain.

class capellambse.model.crosslayer.fa.FunctionalChainInvolvement

Bases: AbstractInvolvement

Abstract class for FunctionalChainInvolvementLink/Function.

class capellambse.model.crosslayer.fa.FunctionalChainInvolvementFunction

Bases: FunctionalChainInvolvement

An element linking a FunctionalChain to a Function.

class capellambse.model.crosslayer.fa.FunctionalChainInvolvementLink

Bases: FunctionalChainInvolvement

An element linking a FunctionalChain to an Exchange.

exchange_context

The exchange context of this FunctionalChainInvolvementLink.

exchanged_items

The exchanged items of this FunctionalChainInvolvementLink.

class capellambse.model.crosslayer.fa.FunctionalChainReference

Bases: FunctionalChainInvolvement

An element linking two related functional chains together.

class capellambse.model.crosslayer.fa.FunctionalExchange

Bases: AbstractExchange

A functional exchange.

allocating_component_exchange

The allocating component exchange of this FunctionalExchange.

exchange_items

The exchange items of this FunctionalExchange.

involving_functional_chains

The involving functional chains of this FunctionalExchange.

property owner: ComponentExchange | None

realized_functional_exchanges

The realized functional exchanges of this FunctionalExchange.

realizing_functional_exchanges: c.Accessor[FunctionalExchange]

The realizing functional exchanges of this FunctionalExchange.

capellambse.model.crosslayer.interaction module

class capellambse.model.crosslayer.interaction.AbstractCapabilityExtend

Bases: Exchange

An AbstractCapabilityExtend.

source

The source of this AbstractCapabilityExtend.

target

The target of this AbstractCapabilityExtend.

class capellambse.model.crosslayer.interaction.AbstractCapabilityGeneralization

Bases: Exchange

An AbstractCapabilityGeneralization.

source

The source of this AbstractCapabilityGeneralization.

target

The target of this AbstractCapabilityGeneralization.

class capellambse.model.crosslayer.interaction.AbstractCapabilityInclude

Bases: Exchange

An AbstractCapabilityInclude.

source

The source of this AbstractCapabilityInclude.

target

The target of this AbstractCapabilityInclude.

class capellambse.model.crosslayer.interaction.AbstractFunctionAbstractCapabilityInvolvement

Bases: AbstractInvolvement

An abstract CapabilityInvolvement linking to SystemFunctions.

class capellambse.model.crosslayer.interaction.AbstractInvolvement

Bases: GenericElement

An abstract Involvement.

involved

The involved of this AbstractInvolvement.

property name: str

Return the name.

source

The source of this AbstractInvolvement.

target

The target of this AbstractInvolvement.

class capellambse.model.crosslayer.interaction.CombinedFragment

Bases: Execution

A combined fragment.

operands

The operands of this CombinedFragment.

operator

class capellambse.model.crosslayer.interaction.Event

Bases: GenericElement

Abstract super class of all events in a Scenario.

class capellambse.model.crosslayer.interaction.EventOperation

Bases: Event

Abstract super class for events about operations.

operation

The operation of this EventOperation.

class capellambse.model.crosslayer.interaction.EventReceiptOperation

Bases: EventOperation

An event-receipt operation.

class capellambse.model.crosslayer.interaction.EventSentOperation

Bases: EventOperation

An event-sent operation.

class capellambse.model.crosslayer.interaction.Exchange

Bases: GenericElement

An abstract Exchange.

source

The source of this Exchange.

class capellambse.model.crosslayer.interaction.Execution

Bases: GenericElement

An execution.

finish

The finish of this Execution.

start

The start of this Execution.

class capellambse.model.crosslayer.interaction.ExecutionEnd

Bases: InteractionFragment

An end for an execution.

event

The event of this ExecutionEnd.

class capellambse.model.crosslayer.interaction.ExecutionEvent

Bases: Event

An execution event.

class capellambse.model.crosslayer.interaction.FragmentEnd

Bases: InteractionFragment

An end for a fragment.

class capellambse.model.crosslayer.interaction.InstanceRole

Bases: GenericElement

An instance role.

instance

The instance of this InstanceRole.

class capellambse.model.crosslayer.interaction.InteractionFragment

Bases: GenericElement

Abstract super class of all interaction fragments in a Scenario.

covered

The covered of this InteractionFragment.

class capellambse.model.crosslayer.interaction.InteractionOperand

Bases: InteractionFragment

An interaction-operand.

guard

The guard of this InteractionOperand.

class capellambse.model.crosslayer.interaction.InteractionState

Bases: InteractionFragment

An interaction-state.

function

The function of this InteractionState.

state

The state of this InteractionState.

class capellambse.model.crosslayer.interaction.MessageEnd

Bases: InteractionFragment

A message-end.

event

The event of this MessageEnd.

class capellambse.model.crosslayer.interaction.Scenario

Bases: GenericElement

A scenario that holds instance roles.

events

The events of this Scenario.

fragments

The fragments of this Scenario.

instance_roles

The instance roles of this Scenario.

messages

The messages of this Scenario.

postcondition

The postcondition of this Scenario.

precondition

The precondition of this Scenario.

time_lapses

The time lapses of this Scenario.

class capellambse.model.crosslayer.interaction.SequenceMessage

Bases: GenericElement

A sequence message.

source

The source of this SequenceMessage.

target

The target of this SequenceMessage.

class capellambse.model.crosslayer.interaction.StateFragment

Bases: Execution

A state fragment.

function

The function of this StateFragment.

capellambse.model.crosslayer.modellingcore module

Abstract classes acting as templates for concrete classes.

These base classes are used between different layers.

class capellambse.model.crosslayer.modellingcore.TraceableElement

Bases: GenericElement

A template for traceable ModelObjects.

source

The source of this TraceableElement.

target

The target of this TraceableElement.