pygrenade_vx.network.Compartment

class pygrenade_vx.network.Compartment

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)

Overloaded function.

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

Methods

`__init__`(args, *kwargs)	Overloaded function.
`add`(self, mechanism)
`copy`(self)
`get`(self, descriptor)
`get_hardware`(self, compartment, environment)
`move`(self)
`remove`(self, descriptor)
`set`(self, descriptor, mechanism)
`valid`(self)	Returns if all mechanisms on the compartment are valid.

add(self: _pygrenade_vx_network.Compartment, mechanism: _pygrenade_vx_network.Mechanism) → _pygrenade_vx_network.MechanismOnCompartment

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

get(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment) → _pygrenade_vx_network.Mechanism

get_hardware(self: _pygrenade_vx_network.Compartment, compartment: grenade::vx::network::abstract::CompartmentOnNeuron, environment: grenade::vx::network::abstract::Environment) → dict[_pygrenade_vx_network.MechanismOnCompartment, grenade::vx::network::abstract::HardwareResourcesWithConstraints]

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

remove(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment) → None

set(self: _pygrenade_vx_network.Compartment, descriptor: _pygrenade_vx_network.MechanismOnCompartment, mechanism: _pygrenade_vx_network.Mechanism) → None

valid(self: _pygrenade_vx_network.Compartment) → bool: Returns if all mechanisms on the compartment are valid.