niryo_libraries.diagnostic_updater._publisher.TopicDiagnostic

class documentation

class TopicDiagnostic(HeaderlessTopicDiagnostic):

Known subclasses: niryo_libraries.diagnostic_updater._publisher.DiagnosedPublisher

Constructor: TopicDiagnostic(name, diag, freq, stamp)

View In Hierarchy

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

Method __init__ Constructs a TopicDiagnostic.
Method tick Collects statistics and publishes the message.
Instance Variable stamp Undocumented

Inherited from HeaderlessTopicDiagnostic:

Method clear_window Clears the frequency statistics.
Instance Variable diag Undocumented
Instance Variable freq Undocumented

Inherited from CompositeDiagnosticTask (via HeaderlessTopicDiagnostic):

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

Inherited from DiagnosticTask (via HeaderlessTopicDiagnostic, CompositeDiagnosticTask):

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

Constructs a TopicDiagnostic.

@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.

@param stamp The parameters for the TimeStampStatus class that will be computing statistics.

def tick(self, stamp):
overrides niryo_libraries.diagnostic_updater._publisher.HeaderlessTopicDiagnostic.tick

Collects statistics and publishes the message.

@param stamp Timestamp to use for interval computation by the TimeStampStatus class.

stamp =

Undocumented