Base multi wrapper

---

Air Force Research Laboratory (AFRL) Autonomous Capabilities Team (ACT3) Reinforcement Learning (RL) Core.

This is a US Government Work not subject to copyright protection in the US.

The use, dissemination or disclosure of data in this file is subject to limitation or restriction. See accompanying README and LICENSE for details.

---

BaseMultiWrapperGlue (BaseAgentGlue)

A base object that glues can inherit in order to "wrap" multiple glue instances

Source code in corl/glues/base_multi_wrapper.py

class BaseMultiWrapperGlue(BaseAgentGlue):
    """A base object that glues can inherit in order to "wrap" multiple glue instances
    """

    def __init__(self, **kwargs) -> None:
        self.config: BaseMultiWrapperGlueValidator
        super().__init__(**kwargs)

    @property
    def get_validator(self) -> Type[BaseMultiWrapperGlueValidator]:
        return BaseMultiWrapperGlueValidator

    def glues(self) -> List[BaseAgentGlue]:
        """Get the wrapped glue instances
        """
        return self.config.wrapped

    def set_agent_removed(self, agent_removed: bool = True) -> None:
        super().set_agent_removed(agent_removed)
        for glue in self.glues():
            glue.set_agent_removed()

get_validator: Type[corl.glues.base_multi_wrapper.BaseMultiWrapperGlueValidator] property readonly

returns the validator for this class

Returns:

Type	Description
Type[corl.glues.base_multi_wrapper.BaseMultiWrapperGlueValidator]	BaseAgentGlueValidator -- A pydantic validator to be used to validate kwargs

glues(self)

Get the wrapped glue instances

Source code in corl/glues/base_multi_wrapper.py

def glues(self) -> List[BaseAgentGlue]:
    """Get the wrapped glue instances
    """
    return self.config.wrapped

set_agent_removed(self, agent_removed=True)

Notify the glue that the agent it is 'attached' to has been removed by the simulation

Source code in corl/glues/base_multi_wrapper.py

def set_agent_removed(self, agent_removed: bool = True) -> None:
    super().set_agent_removed(agent_removed)
    for glue in self.glues():
        glue.set_agent_removed()

BaseMultiWrapperGlueValidator (BaseAgentGlueValidator) pydantic-model

wrapped - the wrapped glue instances

Source code in corl/glues/base_multi_wrapper.py

class BaseMultiWrapperGlueValidator(BaseAgentGlueValidator):
    """
    wrapped - the wrapped glue instances
    """
    wrapped: List[BaseAgentGlue]

    class Config:  # pylint: disable=C0115, R0903
        arbitrary_types_allowed = True