AnnotatorComm.h

/*-----------------------------------------------------------------------------
 * AnnotatorComm declaration
 * Ionetrics 2006
 * John Williams
 * AnnotatorComm.h
 *---------------------------------------------------------------------------*/

#ifndef ANNOTATORCOMM_H
#define ANNOTATORCOMM_H

//-----------------------------------------------------------------------------

#include <string>
#include <vector>

#include "AnnotatorCommApi.h"
#include "CommandMessage.h"
#include "DeviceId.h"
#include "FirmwareVersion.h"
#include "GenericAsynchronousCommands.h"
#include "GenericSynchronousCommands.h"
#include "InputStream.h"
#include "IOException.h"
#include "MicrosecondTimestamp.h"
#include "OutputStream.h"
#include "ResponseMessage.h"
#include "ResponseMessageQueue.h"
#include "ResponseReader.h"
#include "TextMessageListener.h"
#include "TimeSource.h"
#include "TimeSourceLockStatus.h"
#include "Timestamp.h"
#include "TimestampListener.h"

using namespace std;

//-----------------------------------------------------------------------------

namespace annotatorcomm
{

class ANNCOMM_API AnnotatorComm
{
public:
        static const string VERSION;
        
        static const unsigned int MAX_NAME_LEN;
        
        static const int STX;
        
        static const int ETX;
        
        static string getLibAnnotatorCommVersion();
        
public:
        AnnotatorComm(InputStream* in, OutputStream* out);
        
        virtual ~AnnotatorComm();
        
        virtual void close() throw(IOException);
    
        virtual void signal(ResponseMessage & rsp);

        virtual void addTimestampListener(TimestampListener* listener);
        
        virtual void removeTimestampListener(TimestampListener* listener);
        
        virtual vector<TimestampListener*> getTimestampListeners();
        
        virtual void addTextMessageListener(TextMessageListener* listener);
            
        virtual void removeTextMessageListener(TextMessageListener* listener);
        
        virtual vector<TextMessageListener*> getTextMessageListeners();
    
        void noop() throw(IOException);
        
        const DeviceId* getDeviceId() throw(IOException);
        
        FirmwareVersion getFirmwareVersion() throw(IOException);
        
        string getFirmwareTimestamp() throw(IOException);
        
        int getSerialNumber() throw(IOException);
        
        void setSerialNumber(int serialno, int key) throw(IOException);
        
        string getDeviceName() throw(IOException);
        
        void setDeviceName(string name) throw(IOException);
        
        vector<const TimeSource*> getSupportedTimeSources() throw(IOException);
        
        const TimeSource* getTimeSource() throw(IOException);
        
        void setTimeSource(const TimeSource* source) throw(IOException);
        
        MicrosecondTimestamp getCurrentTime() throw(IOException);
        
        void setCurrentTime(MicrosecondTimestamp & timestamp) throw(IOException);
        
        const TimeSourceLockStatus* getTimeSourceLockStatus() throw(IOException);
        
        void setTimeSourceTimestampMode(bool isEnabled) throw(IOException);
        
        bool isTimeSourceTimestampMode() throw(IOException);
        
        void saveOptions() throw(IOException);

protected:
        virtual ResponseMessage sendRecv(CommandMessage & msg) throw(IOException);

        virtual void signalTimestampListeners(Timestamp & timestamp);
        
        virtual void signalSynchronousResponse(ResponseMessage & rsp);

private:
        InputStream* in;
        
        OutputStream* out;
        
        ResponseReader* reader;
        
        ResponseMessageQueue responseMessageQueue;
        
        vector<TimestampListener*> timestampListeners;
        
        vector<TextMessageListener*> textMessageListeners;
};

}

//-----------------------------------------------------------------------------

#endif /* ANNOTATORCOMM_H */

---