Goby v2
Protected Member Functions | List of all members
goby::common::ZeroMQApplicationBase Class Referenceabstract
Inheritance diagram for goby::common::ZeroMQApplicationBase:
Inheritance graph
[legend]

Protected Member Functions

 ZeroMQApplicationBase (ZeroMQService *service, google::protobuf::Message *cfg=0)
 
virtual void loop ()=0
 
void set_loop_period (boost::posix_time::time_duration p)
 set the interval (with a boost::posix_time::time_duration) between calls to loop. Alternative to set_loop_freq(). More...
 
void set_loop_period (long milliseconds)
 set the interval in milliseconds between calls to loop. Alternative to set_loop_freq(). More...
 
void set_loop_freq (double hertz)
 set the frequency with which loop() is called. Alternative to set_loop_period(). More...
 
boost::posix_time::time_duration loop_period ()
 interval between calls to loop()
 
long loop_freq ()
 frequency of calls to loop() in Hertz
 
boost::posix_time::ptime t_start ()
 

Additional Inherited Members

- Public Member Functions inherited from goby::common::ApplicationBase
 ApplicationBase (google::protobuf::Message *cfg=0)
 
void quit ()
 Requests a clean (return 0) exit.
 
std::string application_name ()
 name of this application (from AppBaseConfig::app_name). E.g. "garmin_gps_g"
 
std::string platform_name ()
 name of this platform (from AppBaseConfig::platform_name). E.g. "AUV-23" or "unicorn"
 
template<typename App , typename Config >
friend int::goby::run (int argc, char *argv[], Config *cfg)
 
const AppBaseConfigbase_cfg ()
 

Detailed Description

Definition at line 36 of file zeromq_application_base.h.

Member Function Documentation

void goby::common::ZeroMQApplicationBase::set_loop_freq ( double  hertz)
inlineprotected

set the frequency with which loop() is called. Alternative to set_loop_period().

Parameters
hertznew frequency for loop()

Definition at line 70 of file zeromq_application_base.h.

void goby::common::ZeroMQApplicationBase::set_loop_period ( boost::posix_time::time_duration  p)
inlineprotected

set the interval (with a boost::posix_time::time_duration) between calls to loop. Alternative to set_loop_freq().

Parameters
pnew interval between calls to loop()

Definition at line 58 of file zeromq_application_base.h.

void goby::common::ZeroMQApplicationBase::set_loop_period ( long  milliseconds)
inlineprotected

set the interval in milliseconds between calls to loop. Alternative to set_loop_freq().

Parameters
millisecondsnew period for loop() synchronous event

Definition at line 62 of file zeromq_application_base.h.

boost::posix_time::ptime goby::common::ZeroMQApplicationBase::t_start ( )
inlineprotected
Returns
absolute time that this application was launched

Definition at line 80 of file zeromq_application_base.h.


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