niryo_libraries.diagnostic_updater._publisher.HeaderlessTopicDiagnostic

class documentation

class HeaderlessTopicDiagnostic(CompositeDiagnosticTask):

Known subclasses: niryo_libraries.diagnostic_updater._publisher.TopicDiagnostic

Constructor: HeaderlessTopicDiagnostic(name, diag, freq)

View In Hierarchy

A class to facilitate making diagnostics for a topic using a FrequencyStatus.

The word "headerless" in the class name refers to the fact that it is mainly designed for use with messages that do not have a header, and that cannot therefore be checked using a TimeStampStatus.

Method __init__ Constructs a HeaderlessTopicDiagnostic.
Method clear_window Clears the frequency statistics.
Method tick Signals that a publication has occurred.
Instance Variable diag Undocumented
Instance Variable freq Undocumented

Inherited from CompositeDiagnosticTask:

Method addTask Adds a child CompositeDiagnosticTask.
Method run Runs each child and merges their outputs.
Instance Variable tasks Undocumented

Inherited from DiagnosticTask (via CompositeDiagnosticTask):

Method getName Returns the name of the DiagnosticTask.
Instance Variable name Undocumented
def __init__(self, name, diag, freq):
overrides niryo_libraries.diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.__init__
overridden in niryo_libraries.diagnostic_updater._publisher.TopicDiagnostic

Constructs a HeaderlessTopicDiagnostic.

@param name The name of the topic that is being diagnosed.

@param diag The diagnostic_updater that the CompositeDiagnosticTask should add itself to.

@param freq The parameters for the FrequencyStatus class that will be computing statistics.

def clear_window(self):

Clears the frequency statistics.

def tick(self):
overridden in niryo_libraries.diagnostic_updater._publisher.TopicDiagnostic

Signals that a publication has occurred.

diag =

Undocumented

freq =

Undocumented