robokudo.annotators.testing

Classes

SlowAnnotator

EmptyAnnotator

FailingAnnotator

A 'caffe' Annotator which is just an example of a long-running annotator utilizing the ThreadedAnnotator class.

FakeCollectionReaderAnnotator

A collection reader that just waits for a couple of iterations until it lets go and the rest

ScopedAnnotator

Show how analysis scopes are used

Module Contents

class robokudo.annotators.testing.SlowAnnotator(name='SlowAnnotator', sleep_in_s=1)

Bases: robokudo.annotators.core.ThreadedAnnotator

sleep_in_s = 1
compute()

This method is doing the heavy lifting of the annotator, if it takes to long to run.

class robokudo.annotators.testing.EmptyAnnotator(name='EmptyAnnotator', sleep_in_s=1)

Bases: robokudo.annotators.core.BaseAnnotator

update()

This method is doing the heavy lifting of the annotator, if it takes to long to run.

class robokudo.annotators.testing.FailingAnnotator(name='FailingAnnotator')

Bases: robokudo.annotators.core.ThreadedAnnotator

A ‘caffe’ Annotator which is just an example of a long-running annotator utilizing the ThreadedAnnotator class.

counter = 0
initialise()

Called when first tick is received and anytime status is not running after.

compute()

This method is doing the heavy lifting of the annotator, if it takes to long to run.

class robokudo.annotators.testing.FakeCollectionReaderAnnotator(name='FakeCollectionReader')

Bases: robokudo.annotators.core.BaseAnnotator

A collection reader that just waits for a couple of iterations until it lets go and the rest of the pipeline can continue.

collection_readers
setup(timeout)

Delayed initialisation. For example ROS pub/sub, drivers,

initialise()

Called when first tick is received and anytime status is not running after.

update()

Called every time the behavior is ticked.

terminate(new_status)

Called whenever behavior switches to !RUNNING state. new_status can be SUCCESS, FAILURE or INVALID

class robokudo.annotators.testing.ScopedAnnotator(name='ScopedAnnotator', descriptor=Descriptor())

Bases: robokudo.annotators.core.BaseAnnotator

Show how analysis scopes are used

class Descriptor

Bases: robokudo.annotators.core.BaseAnnotator.Descriptor

class Parameters
analysis_scope
parameters
update()

Called every time the behavior is ticked.