cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
mtsWatchdogServer Class Reference

#include <mtsWatchdogServer.h>

Inheritance diagram for mtsWatchdogServer:
cmnGenericObject

Public Member Functions

 mtsWatchdogServer (void)
 
 ~mtsWatchdogServer ()
 
void AddToProvidedInterface (mtsInterfaceProvided &provInt, mtsStateTable &stateTable)
 
void SetTimeoutPeriod (const double &seconds)
 
void Start (void)
 
bool CheckAndUpdate (void)
 
void Reset (void)
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual void ToStream (std::ostream &outputStream) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
virtual void SerializeRaw (std::ostream &outputStream) const
 
virtual void DeSerializeRaw (std::istream &inputStream)
 
virtual cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
virtual size_t ScalarNumber (void) const
 
virtual bool ScalarNumberIsFixed (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 

Protected Attributes

osaStopwatch StopWatch
 
double Timeout
 
mtsFunctionWriteWatchdogReadBool
 
mtsFunctionWriteWatchdogWriteBool
 
bool IsOK
 
bool WatchdogState
 

Detailed Description

A tool for observing a connection between two components for a set amount of time.

Todo:
Should be easy to merge server and client into a single object. Could integrate into standard component interfaces.

Constructor & Destructor Documentation

mtsWatchdogServer::mtsWatchdogServer ( void  )
inline
mtsWatchdogServer::~mtsWatchdogServer ( )
inline

Member Function Documentation

void mtsWatchdogServer::AddToProvidedInterface ( mtsInterfaceProvided provInt,
mtsStateTable stateTable 
)
bool mtsWatchdogServer::CheckAndUpdate ( void  )
void mtsWatchdogServer::Reset ( void  )
void mtsWatchdogServer::SetTimeoutPeriod ( const double &  seconds)
inline
void mtsWatchdogServer::Start ( void  )

Member Data Documentation

bool mtsWatchdogServer::IsOK
protected
osaStopwatch mtsWatchdogServer::StopWatch
protected
double mtsWatchdogServer::Timeout
protected
mtsFunctionWrite* mtsWatchdogServer::WatchdogReadBool
protected
bool mtsWatchdogServer::WatchdogState
protected
mtsFunctionWrite* mtsWatchdogServer::WatchdogWriteBool
protected

The documentation for this class was generated from the following file: