CalFile.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
 **
 ** 2006, 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_CORE_CALFILE_H
#define NIDAS_CORE_CALFILE_H

#include "DOMable.h"
#include <nidas/util/UTime.h>
#include <nidas/util/IOException.h>
#include <nidas/util/EOFException.h>

#include <vector>
#include <fstream>

#include <regex.h>

namespace nidas { namespace core {

class DSMSensor;

class CalFile: public nidas::core::DOMable {
public:

    CalFile();

    CalFile(const CalFile&);

    CalFile& operator=(const CalFile&);

    ~CalFile();

    const std::string& getFile() const;

    void setFile(const std::string& val);

    const std::string& getPath() const;

    void setPath(const std::string& val);

    static std::vector<std::string> getAllPaths()
    {
        _staticMutex.lock();
        std::vector<std::string> tmp = _allPaths;
        _staticMutex.unlock();
        return tmp;
    }

    const std::string& getCurrentFileName() const
    {
        if (_include) return _include->getCurrentFileName();
        return _currentFileName;
    }

    void setName(const std::string& val) 
    {
        _name = val;
    }

    const std::string& getName() const
    {
        return _name;
    }

    int getLineNumber() const
    {
        if (_include) return _include->getLineNumber();
        return _nline;
    }

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

    void close() throw();

    bool eof() const {
        if (_include) return false;
        return _eofState;
    }

    const std::string& getTimeZone() const { return _timeZone; }

    void
    setTimeZone(const std::string& val);

    const std::string& getDateTimeFormat() const
    {
        return _dateTimeFormat;
    }

    void setDateTimeFormat(const std::string& val);

    nidas::util::UTime search(const nidas::util::UTime& tsearch)
        throw(nidas::util::IOException,nidas::util::ParseException);

    int readCF(nidas::util::UTime& time, float* data, int ndata,
               std::vector<std::string>* fields=0)
        throw(nidas::util::IOException,nidas::util::ParseException);

    const std::vector<std::string>&
    getCurrentFields(nidas::util::UTime* time = 0);

    nidas::util::UTime
    getCurrentTime()
    {
        return _currentTime;
    }

    float
    getFloatField(int column, const std::vector<std::string>* fields = 0);

    int
    getFields(int begin, int end, float* data,
              const std::vector<std::string>* fields = 0);

    /*
     * Return the value of the next time in the file.
     * If there is no next record in the file, the returned value
     * will be far off in the future.
     */
    nidas::util::UTime nextTime() throw()
    {
        return _nextTime;
    }

    void setDSMSensor(const DSMSensor* val);

    const DSMSensor* getDSMSensor() const;

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

protected:

    nidas::util::UTime parseTime() throw(nidas::util::ParseException);

    void readLine() throw(nidas::util::IOException,nidas::util::ParseException);

    bool
    parseTimeComments();

    int
    parseInclude();

    void openInclude(const std::string& name)
        throw(nidas::util::IOException,nidas::util::ParseException);

    int
    readCFInclude(nidas::util::UTime& time, float* data, int ndata,
                  std::vector<std::string>* fields_out);


private:

    nidas::util::UTime readTime()
        throw(nidas::util::IOException,nidas::util::ParseException);

    int readCFNoLock(nidas::util::UTime& time, float* data, int ndata,
                     std::vector<std::string>* fields)
        throw(nidas::util::IOException,nidas::util::ParseException);

    std::string _name;

    std::string _fileName;

    std::string _path;

    std::string _currentFileName;

    std::string _timeZone;

    bool _utcZone;

    std::string _dateTimeFormat;

    std::ifstream _fin;

    static const int INITIAL_CURLINE_LENGTH = 128;

    int _curlineLength;

    char *_curline;

    int _curpos;

    bool _eofState;

    int _nline;

    nidas::util::UTime _nextTime;

    nidas::util::UTime _currentTime;
    std::vector<std::string> _currentFields;

    nidas::util::UTime _includeTime;

    nidas::util::UTime _timeAfterInclude;

    nidas::util::UTime _timeFromInclude;

    CalFile* _include;

    const DSMSensor* _sensor;

    static nidas::util::Mutex _staticMutex;

    static int _reUsers;

    static bool _reCompiled;

    static regex_t _dateFormatPreg;

    static regex_t _timeZonePreg;

    static regex_t _includePreg;

    static void freeREs();

    static void compileREs() throw(nidas::util::ParseException);

    static std::vector<std::string> _allPaths;

    nidas::util::Mutex _mutex;
};

}}  // namespace nidas namespace core

#endif