Base dict 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.

---

BaseDictWrapperGlue (BaseAgentGlue)

A base object that glues can inherit in order to "wrap" multiple glue instances, addressed by keys

Source code in corl/glues/base_dict_wrapper.py

class BaseDictWrapperGlue(BaseAgentGlue):
    """A base object that glues can inherit in order to "wrap" multiple glue instances, addressed by keys
    """

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

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

    def glues(self) -> Dict[str, BaseAgentGlue]:
        """Get the wrapped glue instances dict
        """
        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().values():
            glue.set_agent_removed()

get_validator: Type[corl.glues.base_dict_wrapper.BaseDictWrapperGlueValidator] property readonly

returns the validator for this class

Returns:

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

glues(self)

Get the wrapped glue instances dict

Source code in corl/glues/base_dict_wrapper.py

def glues(self) -> Dict[str, BaseAgentGlue]:
    """Get the wrapped glue instances dict
    """
    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_dict_wrapper.py

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

BaseDictWrapperGlueValidator (BaseAgentGlueValidator) pydantic-model

wrap_dict - A dict of the wrapped glues

Source code in corl/glues/base_dict_wrapper.py

class BaseDictWrapperGlueValidator(BaseAgentGlueValidator):
    """
    wrap_dict - A dict of the wrapped glues
    """
    wrapped: Dict[str, BaseAgentGlue]

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