Names.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_NAMES_HPP
#define __OPENTREP_NAMES_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
#include <list>
#include <map>
// OpenTrep
#include <opentrep/OPENTREP_Abstract.hpp>
#include <opentrep/OPENTREP_Types.hpp>

namespace OPENTREP {


  // ////////////////// Type definitions ///////////////////
  typedef std::list<std::string> NameList_T;

  struct Names : public OPENTREP_Abstract {
  public:
    // //// Constructors / Destructors ///////
    Names (const LanguageCode_T&);
    Names (const Names&);
    ~Names();
  private:
    Names();


  public:
    // /////////// Getters ///////////////
    LanguageCode_T getLanguageCode() const {
      return _languageCode;
    }

    const NameList_T& getNameList() const {
      return _nameList;
    }

    std::string getFirstName() const;


  public:
    // /////////// Setters ///////////////
    void setLanguageCode (const LanguageCode_T& iLanguageCode) {
      _languageCode = iLanguageCode;
    }

    void addName (const std::string& iName);

    void resetList();


  public:
    // /////////// Display support methods /////////
    void toStream (std::ostream& ioOut) const;

    void fromStream (std::istream& ioIn);

    std::string toString() const;

    std::string describeKey() const;

    std::string describe() const;


  private:    
    // //////////// Attributes //////////////
    LanguageCode_T _languageCode;

    NameList_T _nameList;
  };

  // ////////////// Type definitions ////////////
  typedef std::map<LanguageCode_T, Names> NameMatrix_T;

}
#endif // __OPENTREP_NAMES_HPP