SerialSensor.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2011, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
#ifndef NIDAS_DYNLD_SERIALSENSOR_H
#define NIDAS_DYNLD_SERIALSENSOR_H

#include "CharacterSensor.h"
#include "LooperClient.h"
#include "SerialPortIODevice.h"

namespace nidas { namespace core {

using namespace nidas::core;

class SerialSensor : public CharacterSensor
{

public:

    SerialSensor();

    ~SerialSensor();

    nidas::util::Termios& termios() { return _termios; }

    const nidas::util::Termios& getTermios() const { return _termios; }

    SampleScanner* buildSampleScanner()
        throw(nidas::util::InvalidParameterException);

    IODevice* buildIODevice() throw(nidas::util::IOException);

    void open(int flags) throw(nidas::util::IOException,
        nidas::util::InvalidParameterException);

    /*
     * Close the device connected to the sensor.
     */
    void close() throw(nidas::util::IOException);

    void applyTermios() throw(nidas::util::IOException);

    void setMessageParameters(unsigned int len,const std::string& sep, bool eom)
        throw(nidas::util::InvalidParameterException,nidas::util::IOException);

    void printStatus(std::ostream& ostr) throw();

    bool isPrompting() const { return _prompting; }

    void startPrompting() throw(nidas::util::IOException);

    void stopPrompting() throw(nidas::util::IOException);

    void fromDOMElement(const xercesc::DOMElement* node)
        throw(nidas::util::InvalidParameterException);

    int getUsecsPerByte() const;

protected:

    void initPrompting() throw(nidas::util::IOException);

    void shutdownPrompting() throw(nidas::util::IOException);

    void unixDevInit(int flags)
        throw(nidas::util::IOException);

private:

    nidas::util::Termios _termios;

    SerialPortIODevice* _serialDevice;

    class Prompter: public nidas::core::LooperClient
    {
    public:
        Prompter(SerialSensor* sensor): _sensor(sensor),
            _prompt(0),_promptLen(0), _promptPeriodMsec(0),
            _promptOffsetMsec(0) {}

        ~Prompter();

        void setPrompt(const std::string& val);
        const std::string getPrompt() const { return _prompt; }

        void setPromptPeriodMsec(const int);
        int getPromptPeriodMsec() const { return _promptPeriodMsec; }

        void setPromptOffsetMsec(const int);
        int getPromptOffsetMsec() const { return _promptOffsetMsec; }

        void looperNotify() throw();
    private:
        SerialSensor* _sensor;
        char* _prompt;
    int _promptLen;
        int _promptPeriodMsec;
        int _promptOffsetMsec;

        Prompter(const Prompter&);

        Prompter& operator=(const Prompter&);
    };

    std::list<Prompter*> _prompters;

    bool _prompting;

    int _rts485;

    SerialSensor(const SerialSensor&);

    SerialSensor& operator=(const SerialSensor&);

};

}}  // namespace nidas namespace core

#endif