IoDDSStreamItr.h

Go to the documentation of this file.

// $Id: IoDDSStreamItr.h,v 1.13 2007/08/24 05:37:46 schubert Exp $
//
// IoDataStreamItr for data servered by the data dispatcher
//
// messier@huhepl.harvard.edu
#ifndef IODDSSTREAMITR_H
#define IODDSSTREAMITR_H
#ifndef IODATASTREAMITR_H
#include <string>
using namespace std;

#include "IoModules/IoDataStreamItr.h"
#endif
#ifndef DDS_H
#include "Dispatcher/DDS.h"
#endif

class DDSClient;

class IoDDSStreamItr : public IoDataStreamItr
{
public:
  IoDDSStreamItr(const char* server, unsigned int port = DDS::kPort,
                 unsigned int nretry = 0, unsigned int retrydelay = 1,
                 DDS::EClientType = DDS::kUnknownClientType,
                 string clientname = "");
  ~IoDDSStreamItr();
  
  // IoDataStreamItr interface required implementation
  bool        IsValid()   const { return ( fDDSClient ) ? true : false; }
  const char* GetFormat() const { return "dds"; }
  int  LoadRecords(MomNavigator* m);
  int  Increment(int n=1, MomNavigator* m=0);
  int  Decrement(int n=1, MomNavigator* m=0);
  JobCResult GoTo(const VldContext& vld, MomNavigator* m=0);

  // IoDataStreamItr interface overridden implementation
  int  GoToEOF();
  int  Streams(const char* streamlist);
  int  Select(const char* stream, const char* selection, bool isRequired=false);
  void SetTimeOut(unsigned int seconds);
 
  // Specialized methods for this class
  void  SetClientType(DDS::EClientType clienttype);
  void  SetClientName(string clientname);
  void AddFile(const char* filename, int at = -1, 
               const char* streamlist = "*");  
  const char* GetCurrentFile(const char* streamlist = "*") const;
  JobCResult GoToFile(const char* filename, const char* streamlist = "*");
  JobCResult GoToFile(int i, const char* streamlist = "*");
  JobCResult NextFile(int n = 1, const char* streamlist = "*");
  JobCResult PrevFile(int n = 1, const char* streamlist = "*");
  void RemoveFile(const char* filename = "*", 
                  const char* streamlist = "*"); 
  std::ostream& ListFile(std::ostream& ostream, const char* streamlist = "*") const;
  
  int  SetMaxSyncDelay(unsigned int seconds);
  int  SetDataSource(unsigned int datasource);
  int  SetKeepUpMode(unsigned int keepupmode);
  int  SetOffLine(bool offLine = true); 
  int  Subscribe();

  int  GetPort() const { return fPort; }
  DDS::EClientType  GetClientType() const { return fClientType; }
  string  GetClientName() const { return fClientName; }
  bool IsModified() const { return fModified; }

private:
  void InitDDSClient();
  void ShutdownDDSClient();
  
  unsigned int fPort;       // Port number to connect to
  unsigned int fTimeOut;    // Time out in seconds
  unsigned int fMaxRetry;   // Max number of times to retry if connect fails
  unsigned int fRetryDelay; // Delay between connect retries (seconds)
  DDSClient*   fDDSClient;  // dispatcher client
  bool         fModified;   // client subscription is modified
  DDS::EClientType fClientType; // client type used for identification
  string       fClientName; // optional client name uesd for identification
};

#endif

---