parameterSection.h

Go to the documentation of this file.

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

// Format: general  parameter section class

#ifndef BALL_FORMAT_PARAMETERSECTION_H
#define BALL_FORMAT_PARAMETERSECTION_H

#ifndef BALL_DATATYPE_OPTIONS_H
# include <BALL/DATATYPE/options.h>
#endif

namespace BALL 
{
  class Parameters;

  class BALL_EXPORT ParameterSection 
  {
    public:

    BALL_CREATE(ParameterSection)


    
    static const String UNDEFINED;



    enum 
    {
      MAX_FIELDS = 20
    };



    ParameterSection() ;

    ParameterSection(const ParameterSection& parameter_section) ;

    virtual ~ParameterSection() ;



    bool extractSection(Parameters& parameters, const String& section_name)
      ;

    const String& getSectionName() const
      ;

    const String& getValue(const String& key, const String& variable) const
      ;
    
    bool has(const String& key, const String& variable) const ;
    
    bool has(const String& key) const ;
    
    bool hasVariable(const String& variable) const ;

    Position getColumnIndex(const String& variable) const ;

    Size getNumberOfVariables() const ;

    Size getNumberOfKeys() const ;

    const String& getValue(Position key_index, Position variable_index)
      const ;

    const String& getKey(Position key_index) const ;



    virtual void clear() 
      ;

    const ParameterSection& operator = (const ParameterSection& section)
      ;


      
    virtual bool isValid() const ;

    bool operator == (const ParameterSection& parameter_section) const
      ;



    Options options;


    protected:

    /*_ The name of the section.
    */
    String  section_name_;

    /*_ The format line.
    */
    String  format_line_;

    /*_ String hash map containing an index for each key.
        This index is the index for the entries_ array.
    */
    StringHashMap<Index>  section_entries_;

    /*_ String has map relating a variable name to the index in entries_.
    */
    StringHashMap<Index>  variable_names_;
    
    /*_ One-dimensional array of the values read from the section.
        The index of a specific value is calculated as
        section_entries_[key] * number_of_variables_ * variable_names_[name]
    */
    std::vector<String>         entries_;

    /*_ One-dimensional array of the keys read from the section.
    */
    std::vector<String> keys_;

    /*_ The number of variables specified in the format line.
        Variables also include "ver:" entries.
    */
    Size    number_of_variables_;

    /*_ The version numbers of each key.
    */
    std::vector<float>  version_;

    /*_ The valid flag.
    */
    bool    valid_;

  };
} // namespace BALL

#endif // BALL_FORMAT_PARAMETERSECTION_H