pygrenade_vx.network.abstract.Compartment

class pygrenade_vx.network.abstract.Compartment

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)

Overloaded function.

__init__(self: _pygrenade_vx_network_abstract.Compartment) -> None
__init__(self: _pygrenade_vx_network_abstract.Compartment, arg0: _pygrenade_vx_network_abstract.Compartment) -> None

Methods

`__init__`(args, *kwargs)	Overloaded function.
`copy`(self)
`get_hardware`(self, parameter_space, …)
`move`(self)
`valid`(self, parameter_space)	Check if the given paramter space is valid for the compartment.

Attributes

class Mechanisms

Bases: pybind11_builtins.pybind11_object

clear(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms) → None: Remove all elements in the map.

contains(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms, key: _pygrenade_vx_network_abstract.MechanismOnCompartment) → bool: Get whether element for given key is present in map.

empty(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms) → bool: Get whether map is empty and contains no elements.

erase(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms, key: _pygrenade_vx_network_abstract.MechanismOnCompartment) → int: Erase element for given key in map.

get(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms, arg0: _pygrenade_vx_network_abstract.MechanismOnCompartment) → _pygrenade_vx_network_abstract.Mechanism

insert(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms, value: _pygrenade_vx_network_abstract.Mechanism) → _pygrenade_vx_network_abstract.MechanismOnCompartment

set(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms, key: _pygrenade_vx_network_abstract.MechanismOnCompartment, value: _pygrenade_vx_network_abstract.Mechanism) → None

size(self: _pygrenade_vx_network_abstract.Compartment.Mechanisms) → int: Get number of elements present in map.

class ParameterSpace

Bases: pybind11_builtins.pybind11_object

Mechanisms: alias of _pygrenade_vx_network_abstract.Map_grenade_vx_network_abstract_MechanismOnCompartment_grenade_vx_network_abstract_Mechanism_ParameterSpace_

class Parameterization

Bases: pybind11_builtins.pybind11_object

Mechanisms: alias of _pygrenade_vx_network_abstract.Map_grenade_vx_network_abstract_MechanismOnCompartment_grenade_vx_network_abstract_Mechanism_ParameterSpace_Parameterization_

get_section(self: _pygrenade_vx_network_abstract.Compartment.ParameterSpace.Parameterization, sequence: pygrenade_common.MultiIndexSequence) → _pygrenade_vx_network_abstract.Compartment.ParameterSpace.Parameterization

size(self: _pygrenade_vx_network_abstract.Compartment.ParameterSpace.Parameterization) → int

get_section(self: _pygrenade_vx_network_abstract.Compartment.ParameterSpace, sequence: pygrenade_common.MultiIndexSequence) → _pygrenade_vx_network_abstract.Compartment.ParameterSpace

size(self: _pygrenade_vx_network_abstract.Compartment.ParameterSpace) → int

valid(self: _pygrenade_vx_network_abstract.Compartment.ParameterSpace, parameterization: _pygrenade_vx_network_abstract.Compartment.ParameterSpace.Parameterization) → bool: Check if the given parameterization is valid for the parameter space. This checks if the parameterization is valid for each mechanism.

copy(self: _pygrenade_vx_network_abstract.Compartment) → _pygrenade_vx_network_abstract.Compartment

get_hardware(self: _pygrenade_vx_network_abstract.Compartment, parameter_space: _pygrenade_vx_network_abstract.Compartment.ParameterSpace, environment: dict[_pygrenade_vx_network_abstract.MechanismOnCompartment, dapr::PropertyHolder<grenade::vx::network::abstract::MechanismEnvironment, std::unique_ptr>]) → dict[_pygrenade_vx_network_abstract.MechanismOnCompartment, list[dapr::PropertyHolder<grenade::vx::network::abstract::HardwareConstraint, std::unique_ptr>]]

move(self: _pygrenade_vx_network_abstract.Compartment) → _pygrenade_vx_network_abstract.Compartment

valid(self: _pygrenade_vx_network_abstract.Compartment, parameter_space: _pygrenade_vx_network_abstract.Compartment.ParameterSpace) → bool: Check if the given paramter space is valid for the compartment. This checks if the parameter space is valid for all mechanisms.