FileOptions.hpp

Go to the documentation of this file.

/*
 * MOAB, a Mesh-Oriented datABase, is a software component for creating,
 * storing and accessing finite element mesh data.
 * 
 * Copyright 2004 Sandia Corporation.  Under the terms of Contract
 * DE-AC04-94AL85000 with Sandia Coroporation, the U.S. Government
 * retains certain rights in this software.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 */

#ifndef FILE_OPTIONS_HPP
#define FILE_OPTIONS_HPP

#include <string>
#include <vector>
#include "moab/Types.hpp"

namespace moab {

class FileOptions {
public:

  /*\param options_string The concatenation of a list of 
   *          options, separated either by the default separator
   *          (semicolon) with a custom separator specified at
   *          the beginning of the string (semicolon followed by
   *          destired separator character.)
   */
  FileOptions( const char* option_string);
  
  FileOptions( const FileOptions& copy );
  FileOptions& operator=( const FileOptions& copy );
  
  ~FileOptions();
  
  ErrorCode get_null_option( const char* name ) const;
  
  
  ErrorCode get_toggle_option( const char* name, 
                               bool default_value,
                               bool& value ) const;
   
  ErrorCode get_int_option( const char* name, int& value ) const;
  
  ErrorCode get_int_option( const char* name, int default_val, int& value ) const;
  
  ErrorCode get_real_option( const char* name, double& value ) const;
  
  ErrorCode get_str_option( const char* name, std::string& value ) const;
  
  ErrorCode get_option( const char* name, std::string& value ) const;
  
  ErrorCode match_option( const char* name, const char* const* values, int& index ) const;
  
  ErrorCode match_option( const char* name, const char* value) const;
  
  ErrorCode get_ints_option( const char* name, std::vector<int>& values) const;
  
  ErrorCode get_reals_option( const char* name, std::vector<double>& values) const;
  
  ErrorCode get_strs_option( const char* name, std::vector<std::string>& values) const;
  
  inline unsigned size() const 
    { return mOptions.size(); }
  
  inline bool empty() const 
    { return mOptions.empty(); }
  
  void get_options( std::vector<std::string>& list ) const;
  
  bool all_seen() const;
  
  void mark_all_seen() const;
  
  ErrorCode get_unseen_option( std::string& value ) const;
  
private:
  
  ErrorCode get_option( const char* name, const char*& value) const;

  char* mData;
  std::vector<const char*> mOptions;
  mutable std::vector<bool> mSeen;

  static bool compare( const char* name, const char* option );
};
  
} // namespace moab

#endif