GammaWare  Head Version for release 0.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ADF::BaseFrameIO Class Reference

Base class to get/write Frames. More...

#include <FrameIO.h>

Inheritance diagram for ADF::BaseFrameIO:

Public Types

enum  EStatus { kUndefined = 0, kRunning = 1, kStopped = 2, kSuspended = 3, kIdle = 4, kFinished = 5 }
 current state of the FrameIO More...
 

Public Member Functions

 BaseFrameIO (const char *)
 
ConfAgentGetConfAgent () const
 Return the agent which keeps the current configuration for that FrameIO. More...
 
ConfAgent::EModel GetModel () const
 
virtual const std::string & GetName () const
 Name of this FrameIO. More...
 
EStatus GetStatus () const
 
virtual const char * GetStringStatus (EStatus) const
 string corresponding to the current status More...
 
virtual const Char_t * GetType () const
 
virtual void Print (std::ostream &out=std::cout) const
 Print some informations (statistics) More...
 
void SetModel (ConfAgent::EModel model)
 
virtual void SetName (const char *name)
 
void SetStatus (EStatus stat)
 
virtual ~BaseFrameIO ()
 

Protected Attributes

LogMessage Log
 to send messages to the log server More...
 

Detailed Description

Base class to get/write Frames.

This is the base class to get/write Frames in a data flow. It has a unique type (see GetType()).

It is a kind of state machine with several possible status.

  • kUndefined
  • kRunning
  • kStopped
  • kSuspended
  • kIdle
  • kFinished

It could be used just to get frames (kRead), to send frames (kWrite) or both at the same time (kReadWrite).

A FrameIO processes a data flow with many different kind of frames going through. To get the particular frame you are interested in, you should Register using a FrameTrigger.

Definition at line 70 of file FrameIO.h.


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