diff options
Diffstat (limited to 'orbsvcs/examples/RtEC/Kokyu/Consumer.h')
| -rw-r--r-- | orbsvcs/examples/RtEC/Kokyu/Consumer.h | 54 |
1 files changed, 25 insertions, 29 deletions
diff --git a/orbsvcs/examples/RtEC/Kokyu/Consumer.h b/orbsvcs/examples/RtEC/Kokyu/Consumer.h index 36c247802f6..db4593f5d97 100644 --- a/orbsvcs/examples/RtEC/Kokyu/Consumer.h +++ b/orbsvcs/examples/RtEC/Kokyu/Consumer.h @@ -1,18 +1,14 @@ /* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// ORBSVCS Real-time Event Channel examples -// -// = FILENAME -// Consumer -// -// = AUTHOR -// Carlos O'Ryan (coryan@cs.wustl.edu) -// -// ============================================================================ +//============================================================================= +/** + * @file Consumer.h + * + * $Id$ + * + * @author Carlos O'Ryan (coryan@cs.wustl.edu) + */ +//============================================================================= + #ifndef CONSUMER_H #define CONSUMER_H @@ -23,30 +19,30 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class Consumer + * + * @brief Simple consumer object + * + * This class is a consumer of events. + * It simply register for two event typesone event type + * The class is just a helper to simplify common tasks in EC + * tests, such as subscribing for a range of events, disconnecting + * from the EC, informing the driver of shutdown messages, etc. + * There are several ways to connect and disconnect this class, + * and it is up to the driver program to use the right one. + */ class Consumer : public POA_RtecEventComm::PushConsumer { - // = TITLE - // Simple consumer object - // - // = DESCRIPTION - // This class is a consumer of events. - // It simply register for two event typesone event type - // The class is just a helper to simplify common tasks in EC - // tests, such as subscribing for a range of events, disconnecting - // from the EC, informing the driver of shutdown messages, etc. - // - // There are several ways to connect and disconnect this class, - // and it is up to the driver program to use the right one. - // public: + /// Constructor Consumer (void); - // Constructor // = The RtecEventComm::PushConsumer methods + /// The skeleton methods. virtual void push (const RtecEventComm::EventSet& events); virtual void disconnect_push_consumer (void); - // The skeleton methods. }; #endif /* CONSUMER_H */ |