SampleInputHeader.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
 **
 ** 2005, 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_SAMPLEFILEHEADER_H
#define NIDAS_CORE_SAMPLEFILEHEADER_H

#include "IOStream.h"
#include "SampleOutput.h"
#include <nidas/util/ParseException.h>

namespace nidas { namespace core {

class SampleInputHeader
{
public:

    SampleInputHeader();

    SampleInputHeader(const SampleInputHeader&);

    SampleInputHeader& operator=(const SampleInputHeader&);

    ~SampleInputHeader();

    void read(IOStream* iostream) throw(nidas::util::IOException);

    bool parse(IOStream* iostream) throw(nidas::util::ParseException);

    int getLength() const { return _size; }

    std::string toString() const;

    size_t write(SampleOutput* output) const throw(nidas::util::IOException);

    size_t write(IOStream* iostream) const throw(nidas::util::IOException);

    void setArchiveVersion(const std::string& val) { _archiveVersion = val; }
    const std::string& getArchiveVersion() const { return _archiveVersion; }

    void setSoftwareVersion(const std::string& val) { _softwareVersion = val; }
    const std::string& getSoftwareVersion() const { return _softwareVersion; }
                                                                               
    void setProjectName(const std::string& val) { _projectName = val; }
    const std::string& getProjectName() const { return _projectName; }

    void setSystemName(const std::string& val) { _systemName = val; }
    const std::string& getSystemName() const { return _systemName; }

    void setConfigName(const std::string& val) { _configName = val; }
    const std::string& getConfigName() const { return _configName; }

    void setConfigVersion(const std::string& val) { _configVersion = val; }
    const std::string& getConfigVersion() const { return _configVersion; }

protected:

    bool parseMagic(IOStream* iostream) throw(nidas::util::ParseException);

    bool parseTag(IOStream* iostream) throw(nidas::util::ParseException);

    bool parseValue(IOStream* iostream) throw(nidas::util::ParseException);

private:

    // Set method that does nothing.
    void setDummyString(const std::string&) { }

    const std::string& getDummyString() const { return _dummy; }

    struct headerField {

    /* a tag in the file header */
    const char* tag;

        int taglen;

    /* ptr to setXXX member function for setting an attribute of this
     * class, based on the value of the tag from the IOStream.
     */
    void (SampleInputHeader::* setFunc)(const std::string&);

    /* ptr to getXXX member function for getting an attribute of this
     * class, in order to write the value of the tag to the IOStream.
     */
    const std::string& (SampleInputHeader::* getFunc)() const;

    bool obsolete;

    };

    static const struct headerField headers[];

    std::string _archiveVersion;

    std::string _softwareVersion;

    std::string _projectName;

    std::string _systemName;

    std::string _configName;

    std::string _configVersion;

    std::string _dummy;

    static const char* magicStrings[];

    static const int _nmagic;

    int _minMagicLen;

    int _imagic;

    static const int _ntags;

    int _endTag;

    int _tagMatch;

    int _size;

    static const int HEADER_BUF_LEN;

    char* _buf;

    char* _headPtr;

    enum parseStage {PARSE_START, PARSE_MAGIC, PARSE_TAG, PARSE_VALUE, PARSE_DONE} _stage;

};

}}  // namespace nidas namespace core

#endif