sierra.core.generators.generator_factory

Factory for combining controller+scenario XML modification generators.

By combining them together, the result can be easily used to apply modifications to the template XML file to scaffold the batch experiment.

• joint_generator_create(): Combine controller and scenario XML modification generators together.

• scenario_generator_create(): Create a scenario generator using the plugin search path.

• controller_generator_create(): Create a controller generator from the cmdline specification.

sierra.core.generators.generator_factory.joint_generator_create(controller, scenario)

Combine controller and scenario XML modification generators together.

sierra.core.generators.generator_factory.scenario_generator_create(exp_spec: ExperimentSpec, controller, **kwargs)

Create a scenario generator using the plugin search path.

sierra.core.generators.generator_factory.controller_generator_create(controller: str, config_root: Path, cmdopts: Dict[str, Any], exp_spec: ExperimentSpec)

Create a controller generator from the cmdline specification.

• ControllerGenerator: Generate XML changes for a selected --controller.

class sierra.core.generators.generator_factory.ControllerGenerator(controller: str, config_root: Path, cmdopts: Dict[str, Any], exp_spec: ExperimentSpec)

Generate XML changes for a selected --controller.

If the specified controller is not found in controllers.yaml for the loaded Project, an assert will be triggered.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.generators.generator_factory', '__doc__': 'Generate XML changes for a selected ``--controller``.\n\n    If the specified controller is not found in ``controllers.yaml`` for the\n    loaded :term:`Project`, an assert will be triggered.\n    ', '__init__': <function ControllerGenerator.__init__>, 'generate': <function ControllerGenerator.generate>, '_pp_for_tag_add': <function ControllerGenerator._pp_for_tag_add>, '_do_tag_add': <function ControllerGenerator._do_tag_add>, '_generate_controller_support': <function ControllerGenerator._generate_controller_support>, '_generate_controller': <function ControllerGenerator._generate_controller>, '__dict__': <attribute '__dict__' of 'ControllerGenerator' objects>, '__weakref__': <attribute '__weakref__' of 'ControllerGenerator' objects>, '__annotations__': {}})

__doc__ = 'Generate XML changes for a selected ``--controller``.\n\n    If the specified controller is not found in ``controllers.yaml`` for the\n    loaded :term:`Project`, an assert will be triggered.\n    '

__init__(controller: str, config_root: Path, cmdopts: Dict[str, Any], exp_spec: ExperimentSpec) → None

__module__ = 'sierra.core.generators.generator_factory'

__weakref__

list of weak references to the object (if defined)

_do_tag_add(exp_def: XMLExpDef, add: TagAdd) → None

_generate_controller(exp_def: XMLExpDef) → None

_generate_controller_support(exp_def: XMLExpDef) → None

_pp_for_tag_add(add: TagAdd, robot_id: Optional[int] = None) → TagAdd

generate(exp_def: XMLExpDef) → XMLExpDef

Generate all modifications to the experiment definition from the controller.

Does not save.