JCAMPFile.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: JCAMPFile.h,v 1.20 2005/12/23 17:01:44 amoll Exp $
//

#ifndef BALL_FORMAT_JCAMPFILE_H
#define BALL_FORMAT_JCAMPFILE_H

#ifndef BALL_FORMAT_LINEBASEDFILE_H
# include <BALL/FORMAT/lineBasedFile.h>
#endif

#ifndef BALL_DATATYPE_STRINGHASHMAP_H
# include <BALL/DATATYPE/stringHashMap.h>
#endif

namespace BALL
{
  class BALL_EXPORT JCAMPFile 
    : public LineBasedFile
  {
    public:

    // The value types supported by JCAMP
    enum ContentType
    {
      STRING,
      NUMERIC,
      ARRAY
    };

    class BALL_EXPORT JCAMPValue
    {
      public:
      String string_value;
      std::vector<double> numeric_value;
      ContentType type;
      
      JCAMPValue() : string_value(""), numeric_value(), type(STRING) {}
      
      bool operator == (const JCAMPValue& value) const
        ;

      bool operator != (const JCAMPValue& value) const
        ;
    };

    typedef std::pair<String, JCAMPValue> KeyValuePair;

    typedef StringHashMap<JCAMPValue> EntryMap;

    typedef StringHashMap<String> HeaderMap;



    JCAMPFile()  {}

    JCAMPFile(const String& name, OpenMode open_mode = std::ios::in)
      throw(Exception::FileNotFound);

    JCAMPFile(const JCAMPFile& file)
      throw(Exception::FileNotFound);

    virtual ~JCAMPFile()  {}



    void read() 
      throw(Exception::ParseError);

    bool write()
      throw(File::CannotWrite);

    HeaderMap& getHeader()  { return header_; }

    const HeaderMap& getHeader() const  { return header_; }

    EntryMap& getEntries()  { return entries_; }

    const EntryMap& getEntries() const  { return entries_; }

    const JCAMPValue& operator [] (const String& name) const { return entries_[name]; }

    double getDoubleValue(const String& name) const 
      throw(Exception::InvalidFormat);
    
    Index getIntValue(const String& name) const 
      throw(Exception::InvalidFormat);

    bool hasEntry(const String& name) const  { return entries_.has(name); }

    bool hasHeader(const String& name) const  { return header_.has(name); }

    const JCAMPFile& operator = (const JCAMPFile& file) ;



    bool operator == (const JCAMPFile& f)  const ;

    bool operator != (const JCAMPFile& f)  const ;

    
    protected:

    HeaderMap header_;

    EntryMap entries_;
  };
}

#endif // BALL_FORMAT_JCAMPFILE_H