sierra.core.ros1.variables.exp_setup

Classes for the --exp-setup cmdline option for ROS1 platforms.

See Experiment Setup for usage documentation.

• ExpSetup: Defines the experimental setup for ROS experiments.

class sierra.core.ros1.variables.exp_setup.ExpSetup(n_secs_per_run: int, n_datapoints: int, n_ticks_per_sec: int, barrier_start: bool, robots_need_timekeeper: bool)

Defines the experimental setup for ROS experiments.

n_secs_per_run

The Experimental Run duration in seconds, NOT Ticks or timesteps.

n_datapoints

How many datapoints to capture during the experimental run.

n_ticks_per_sec

How many times per second robot controllers will be run.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.ros1.variables.exp_setup', '__doc__': '\n    Defines the experimental setup for ROS experiments.\n\n    Attributes:\n\n        n_secs_per_run: The :term:`Experimental Run` duration in seconds, NOT\n                        :term:`Ticks <Tick>` or timesteps.\n\n        n_datapoints: How many datapoints to capture during the experimental\n                      run.\n\n        n_ticks_per_sec: How many times per second robot controllers will be\n                         run.\n\n    ', '__init__': <function ExpSetup.__init__>, 'gen_attr_changelist': <function ExpSetup.gen_attr_changelist>, 'gen_tag_rmlist': <function ExpSetup.gen_tag_rmlist>, 'gen_tag_addlist': <function ExpSetup.gen_tag_addlist>, 'gen_files': <function ExpSetup.gen_files>, '__dict__': <attribute '__dict__' of 'ExpSetup' objects>, '__weakref__': <attribute '__weakref__' of 'ExpSetup' objects>, '__annotations__': {}})

__doc__ = '\n    Defines the experimental setup for ROS experiments.\n\n    Attributes:\n\n        n_secs_per_run: The :term:`Experimental Run` duration in seconds, NOT\n                        :term:`Ticks <Tick>` or timesteps.\n\n        n_datapoints: How many datapoints to capture during the experimental\n                      run.\n\n        n_ticks_per_sec: How many times per second robot controllers will be\n                         run.\n\n    '

__init__(n_secs_per_run: int, n_datapoints: int, n_ticks_per_sec: int, barrier_start: bool, robots_need_timekeeper: bool) → None

__module__ = 'sierra.core.ros1.variables.exp_setup'

__weakref__

list of weak references to the object (if defined)

gen_attr_changelist() → List[AttrChangeSet]

gen_files() → None

gen_tag_addlist() → List[TagAddList]

gen_tag_rmlist() → List[TagRmList]