capellambse.model.layers package

Submodules

capellambse.model.layers.ctx module

Tools for the System Analysis layer.

This is normally the place to declare data used in the model for e.g. functions, actors etc. which is best presented in a glossary document.

class capellambse.model.layers.ctx.Capability

Bases: GenericElement

A capability.

component_involvements

The component involvements of this Capability.

extended_by

The extended by of this Capability.

extends

The extends of this Capability.

generalized_by

The generalized by of this Capability.

generalizes

The generalizes of this Capability.

included_by

The included by of this Capability.

includes

The includes of this Capability.

incoming_exploitations

The incoming exploitations of this Capability.

involved_chains

The involved chains of this Capability.

involved_components

The involved components of this Capability.

involved_functions

The involved functions of this Capability.

owned_chains

The owned chains of this Capability.

packages: Accessor

postcondition

The postcondition of this Capability.

precondition

The precondition of this Capability.

realized_capabilities

The realized capabilities of this Capability.

realizing_capabilities

The realizing capabilities of this Capability.

scenarios

The scenarios of this Capability.

states

The states of this Capability.

class capellambse.model.layers.ctx.CapabilityExploitation

Bases: GenericElement

A CapabilityExploitation.

capability

The capability of this CapabilityExploitation.

property name: str

Return the name.

class capellambse.model.layers.ctx.CapabilityInvolvement

Bases: AbstractInvolvement

A CapabilityInvolvement.

class capellambse.model.layers.ctx.CapabilityPkg

Bases: GenericElement

A capability package that can hold capabilities.

capabilities

The capabilities of this CapabilityPkg.

packages: Accessor

class capellambse.model.layers.ctx.Mission

Bases: GenericElement

A mission.

exploitations

The exploitations of this Mission.

exploits

The exploits of this Mission.

incoming_involvements

The incoming involvements of this Mission.

involvements

The involvements of this Mission.

class capellambse.model.layers.ctx.MissionInvolvement

Bases: AbstractInvolvement

A MissionInvolvement.

class capellambse.model.layers.ctx.MissionPkg

Bases: GenericElement

A system mission package that can hold missions.

missions

The missions of this MissionPkg.

packages: Accessor

The packages of this MissionPkg.

class capellambse.model.layers.ctx.SystemAnalysis

Bases: BaseArchitectureLayer

Provides access to the SystemAnalysis layer of the model.

actor_exchanges

The actor exchanges of this SystemAnalysis.

property all_actors

all_capabilities

The all capabilities of this SystemAnalysis.

all_capability_exploitations

The all capability exploitations of this SystemAnalysis.

all_component_exchanges

The all component exchanges of this SystemAnalysis.

all_components

The all components of this SystemAnalysis.

all_function_exchanges

The all function exchanges of this SystemAnalysis.

property all_functional_chains

all_functions

The all functions of this SystemAnalysis.

all_missions

The all missions of this SystemAnalysis.

capability_package

The capability package of this SystemAnalysis.

component_exchanges

The component exchanges of this SystemAnalysis.

component_package

The component package of this SystemAnalysis.

diagrams: accessors.Accessor[capellambse.model.diagram.Diagram]

The diagrams of this SystemAnalysis.

function_package

The function package of this SystemAnalysis.

mission_package

The mission package of this SystemAnalysis.

root_component

The root component of this SystemAnalysis.

root_function

The root function of this SystemAnalysis.

class capellambse.model.layers.ctx.SystemComponent

Bases: Component

A system component.

allocated_functions

The allocated functions of this SystemComponent.

components

The components of this SystemComponent.

realized_entities

The realized entities of this SystemComponent.

realized_operational_entities

The realized operational entities of this SystemComponent.

realizing_logical_components

The realizing logical components of this SystemComponent.

class capellambse.model.layers.ctx.SystemComponentPkg

Bases: GenericElement

A system component package.

components

The components of this SystemComponentPkg.

packages: Accessor

The packages of this SystemComponentPkg.

state_machines

The state machines of this SystemComponentPkg.

class capellambse.model.layers.ctx.SystemFunction

Bases: Function

A system function.

functions: c.Accessor

The functions of this SystemFunction.

involved_in

The involved in of this SystemFunction.

owner: Accessor

The owner of this SystemFunction.

packages: c.Accessor

The packages of this SystemFunction.

realized_operational_activities

The realized operational activities of this SystemFunction.

realizing_logical_functions

The realizing logical functions of this SystemFunction.

class capellambse.model.layers.ctx.SystemFunctionPkg

Bases: GenericElement

A function package that can hold functions.

functions

The functions of this SystemFunctionPkg.

packages: Accessor

The packages of this SystemFunctionPkg.

capellambse.model.layers.la module

Tools for the Logical Architecture layer.

class capellambse.model.layers.la.CapabilityRealization

Bases: GenericElement

A capability.

involved_chains

The involved chains of this CapabilityRealization.

involved_components

The involved components of this CapabilityRealization.

involved_functions

The involved functions of this CapabilityRealization.

owned_chains

The owned chains of this CapabilityRealization.

packages: c.Accessor

postcondition

The postcondition of this CapabilityRealization.

precondition

The precondition of this CapabilityRealization.

realized_capabilities

The realized capabilities of this CapabilityRealization.

scenarios

The scenarios of this CapabilityRealization.

states

The states of this CapabilityRealization.

class capellambse.model.layers.la.CapabilityRealizationPkg

Bases: GenericElement

A capability package that can hold capabilities.

capabilities

The capabilities of this CapabilityRealizationPkg.

packages: c.Accessor

class capellambse.model.layers.la.LogicalArchitecture

Bases: BaseArchitectureLayer

Provides access to the LogicalArchitecture layer of the model.

actor_exchanges

The actor exchanges of this LogicalArchitecture.

property all_actors

all_capabilities

The all capabilities of this LogicalArchitecture.

all_component_exchanges

The all component exchanges of this LogicalArchitecture.

all_components

The all components of this LogicalArchitecture.

all_function_exchanges

The all function exchanges of this LogicalArchitecture.

property all_functional_chains

all_functions

The all functions of this LogicalArchitecture.

capability_package

The capability package of this LogicalArchitecture.

component_exchanges

The component exchanges of this LogicalArchitecture.

component_package

The component package of this LogicalArchitecture.

diagrams: accessors.Accessor[capellambse.model.diagram.Diagram]

The diagrams of this LogicalArchitecture.

function_package

The function package of this LogicalArchitecture.

root_component

The root component of this LogicalArchitecture.

root_function

The root function of this LogicalArchitecture.

class capellambse.model.layers.la.LogicalComponent

Bases: Component

A logical component on the Logical Architecture layer.

allocated_functions

The allocated functions of this LogicalComponent.

components: c.Accessor

The components of this LogicalComponent.

functions

The functions of this LogicalComponent.

realized_system_components

The realized system components of this LogicalComponent.

realizing_physical_components

The realizing physical components of this LogicalComponent.

class capellambse.model.layers.la.LogicalComponentPkg

Bases: GenericElement

A logical component package.

components

The components of this LogicalComponentPkg.

exchanges

The exchanges of this LogicalComponentPkg.

packages: c.Accessor

The packages of this LogicalComponentPkg.

state_machines

The state machines of this LogicalComponentPkg.

class capellambse.model.layers.la.LogicalFunction

Bases: Function

A logical function on the Logical Architecture layer.

functions: c.Accessor

The functions of this LogicalFunction.

involved_in

The involved in of this LogicalFunction.

owner: c.Accessor[LogicalComponent]

The owner of this LogicalFunction.

packages: c.Accessor

The packages of this LogicalFunction.

realized_system_functions

The realized system functions of this LogicalFunction.

realizing_physical_functions

The realizing physical functions of this LogicalFunction.

class capellambse.model.layers.la.LogicalFunctionPkg

Bases: GenericElement

A logical function package.

functions

The functions of this LogicalFunctionPkg.

packages: c.Accessor

The packages of this LogicalFunctionPkg.

capellambse.model.layers.oa module

Tools for the Operational Analysis layer.

class capellambse.model.layers.oa.AbstractEntity

Bases: Component

Common code for Entities.

activities

The activities of this AbstractEntity.

capabilities

The capabilities of this AbstractEntity.

class capellambse.model.layers.oa.CommunicationMean

Bases: AbstractExchange

An operational entity exchange.

allocated_exchange_items

The allocated exchange items of this CommunicationMean.

allocated_interactions

The allocated interactions of this CommunicationMean.

property exchange_items: ElementList[ExchangeItem]

class capellambse.model.layers.oa.Entity

Bases: AbstractEntity

An Entity in the OperationalAnalysis layer.

entities: c.Accessor

The entities of this Entity.

exchanges

The exchanges of this Entity.

property inputs: ElementList[CommunicationMean]

property outputs: ElementList[CommunicationMean]

realizing_system_components

The realizing system components of this Entity.

related_exchanges

The related exchanges of this Entity.

class capellambse.model.layers.oa.EntityOperationalCapabilityInvolvement

Bases: AbstractInvolvement

An EntityOperationalCapabilityInvolvement.

class capellambse.model.layers.oa.EntityPkg

Bases: GenericElement

A package that holds operational entities.

entities

The entities of this EntityPkg.

exchanges

The exchanges of this EntityPkg.

packages: c.Accessor

The packages of this EntityPkg.

state_machines

The state machines of this EntityPkg.

class capellambse.model.layers.oa.OperationalActivity

Bases: AbstractFunction

An operational activity.

activities

The activities of this OperationalActivity.

exchanges

The exchanges of this OperationalActivity.

inputs

The inputs of this OperationalActivity.

outputs

The outputs of this OperationalActivity.

owner: c.Accessor[Entity]

The owner of this OperationalActivity.

owning_entity

The owning entity of this OperationalActivity.

packages

The packages of this OperationalActivity.

realizing_system_functions

The realizing system functions of this OperationalActivity.

property related_exchanges: ElementList[FunctionalExchange]

class capellambse.model.layers.oa.OperationalActivityPkg

Bases: GenericElement

A package that holds operational entities.

activities

The activities of this OperationalActivityPkg.

packages: c.Accessor

The packages of this OperationalActivityPkg.

class capellambse.model.layers.oa.OperationalAnalysis

Bases: BaseArchitectureLayer

Provides access to the OperationalAnalysis layer of the model.

activity_package

The activity package of this OperationalAnalysis.

all_activities

The all activities of this OperationalAnalysis.

all_activity_exchanges

The all activity exchanges of this OperationalAnalysis.

property all_actors

all_capabilities

The all capabilities of this OperationalAnalysis.

all_entities

The all entities of this OperationalAnalysis.

all_entity_exchanges

The all entity exchanges of this OperationalAnalysis.

property all_operational_processes

all_processes

The all processes of this OperationalAnalysis.

capability_package

The capability package of this OperationalAnalysis.

diagrams: accessors.Accessor[capellambse.model.diagram.Diagram]

The diagrams of this OperationalAnalysis.

entity_package

The entity package of this OperationalAnalysis.

root_activity

The root activity of this OperationalAnalysis.

root_entity

The root entity of this OperationalAnalysis.

class capellambse.model.layers.oa.OperationalCapability

Bases: GenericElement

A capability in the OperationalAnalysis layer.

entity_involvements

The entity involvements of this OperationalCapability.

extended_by

The extended by of this OperationalCapability.

extends

The extends of this OperationalCapability.

generalized_by

The generalized by of this OperationalCapability.

generalizes

The generalizes of this OperationalCapability.

included_by

The included by of this OperationalCapability.

includes

The includes of this OperationalCapability.

involved_activities

The involved activities of this OperationalCapability.

involved_entities

The involved entities of this OperationalCapability.

involved_processes

The involved processes of this OperationalCapability.

owned_processes

The owned processes of this OperationalCapability.

packages: c.Accessor

postcondition

The postcondition of this OperationalCapability.

precondition

The precondition of this OperationalCapability.

realizing_capabilities

The realizing capabilities of this OperationalCapability.

scenarios

The scenarios of this OperationalCapability.

states

The states of this OperationalCapability.

class capellambse.model.layers.oa.OperationalCapabilityPkg

Bases: GenericElement

A package that holds operational capabilities.

capabilities

The capabilities of this OperationalCapabilityPkg.

packages: c.Accessor

The packages of this OperationalCapabilityPkg.

class capellambse.model.layers.oa.OperationalProcess

Bases: FunctionalChain

An operational process.

capellambse.model.layers.pa module

Tools for the Physical Architecture layer.

class capellambse.model.layers.pa.PhysicalArchitecture

Bases: BaseArchitectureLayer

Provides access to the Physical Architecture layer of the model.

property all_actors

all_capabilities

The all capabilities of this PhysicalArchitecture.

all_component_exchanges

The all component exchanges of this PhysicalArchitecture.

all_components

The all components of this PhysicalArchitecture.

all_function_exchanges

The all function exchanges of this PhysicalArchitecture.

property all_functional_chains

all_functions

The all functions of this PhysicalArchitecture.

all_physical_exchanges

The all physical exchanges of this PhysicalArchitecture.

all_physical_links

The all physical links of this PhysicalArchitecture.

all_physical_paths

The all physical paths of this PhysicalArchitecture.

capability_package

The capability package of this PhysicalArchitecture.

component_package

The component package of this PhysicalArchitecture.

diagrams: accessors.Accessor[capellambse.model.diagram.Diagram]

The diagrams of this PhysicalArchitecture.

function_package

The function package of this PhysicalArchitecture.

root_component

The root component of this PhysicalArchitecture.

root_function

The root function of this PhysicalArchitecture.

class capellambse.model.layers.pa.PhysicalComponent

Bases: Component

A physical component on the Physical Architecture layer.

allocated_functions

The allocated functions of this PhysicalComponent.

property components: ElementList[PhysicalComponent]

property deployed_components: ElementList[PhysicalComponent]

deploying_components: c.Accessor

The deploying components of this PhysicalComponent.

functions

The functions of this PhysicalComponent.

kind

nature

owned_components: c.Accessor

The owned components of this PhysicalComponent.

realized_logical_components

The realized logical components of this PhysicalComponent.

class capellambse.model.layers.pa.PhysicalComponentPkg

Bases: GenericElement

A logical component package.

components

The components of this PhysicalComponentPkg.

exchanges

The exchanges of this PhysicalComponentPkg.

packages: c.Accessor

The packages of this PhysicalComponentPkg.

state_machines

The state machines of this PhysicalComponentPkg.

class capellambse.model.layers.pa.PhysicalFunction

Bases: Function

A physical function on the Physical Architecture layer.

functions: c.Accessor

The functions of this PhysicalFunction.

owner: c.Accessor[PhysicalComponent]

The owner of this PhysicalFunction.

packages: c.Accessor

The packages of this PhysicalFunction.

realized_logical_functions

The realized logical functions of this PhysicalFunction.

class capellambse.model.layers.pa.PhysicalFunctionPkg

Bases: GenericElement

A logical component package.

functions

The functions of this PhysicalFunctionPkg.

packages: c.Accessor

The packages of this PhysicalFunctionPkg.