Handler classes related to hierarchy

Hierarchy handler

class simu.core.model.hierarchy.HierarchyHandler

This class, being instantiated as the simu.Model.hierarchy attribute, allows to define child models in a hierarchy context.

__init__(model: Model)

declare(name: str, model_cls: Type[Model]) → None

Declare a sub-model in the interface, and by that

1. Demand that it will be instantiated, and

2. Make it available in the hierarchy proxy for browsing from parent context.

add(

name: str,

model_cls: Type[Model],

*args: Any,

**kwargs: Any,

) → ModelProxy

Add an instance of the class model_cls as child to the current (parent) context. A ModelProxy object is created, registered, and returned.

property declared: Mapping[str, Type[Model]]

Dictionary of declared sub-models

create_proxy() → HierarchyProxy

Create a proxy object for configuration in hierarchy context

check_complete()

Check that all declared child models are defined

HierarchyProxy

class simu.core.model.hierarchy.HierarchyProxy

A wrapper of the HierarchyHandler to grant access to the previously declared sub-models.

__init__(handler: HierarchyHandler)

finalise()

Check that the child models declared in the interface are implemented