Header.hpp

Go to the documentation of this file.

#ifndef IFW_DIT_DID_HEADER_HPP_
#define IFW_DIT_DID_HEADER_HPP_

#include <string>

#include "ctd/defines/defines.hpp"

#include "ctd/file/Yaml.hpp"


namespace dit {
namespace did {

class Header {
public:

    static const std::string HEADER_TAG;

    typedef enum {
        DID_HDR_FIELD_NAME         =  1,
        DID_HDR_FIELD_SCOPE        =  2,
        DID_HDR_FIELD_CRE_DATE     =  4,
        DID_HDR_FIELD_VERSION      =  8,
        DID_HDR_FIELD_INCLUDE      = 16,
        DID_HDR_FIELD_DESCRIPTION  = 32,

        DID_HDR_FIELD_ALL = (DID_HDR_FIELD_NAME | DID_HDR_FIELD_SCOPE | DID_HDR_FIELD_CRE_DATE |
        DID_HDR_FIELD_VERSION | DID_HDR_FIELD_INCLUDE | DID_HDR_FIELD_DESCRIPTION)

    } DidHdrField;

    static const std::string DID_HDR_FIELD_NAME_STR;
    static const std::string DID_HDR_FIELD_SCOPE_STR;
    static const std::string DID_HDR_FIELD_CRE_DATE_STR;
    static const std::string DID_HDR_FIELD_VERSION_STR;
    static const std::string DID_HDR_FIELD_INCLUDE_STR;
    static const std::string DID_HDR_FIELD_DESCRIPTION_STR;
    static const std::map<DidHdrField, std::string> s_did_hdr_fields_nb_map;
    static const std::map<std::string, DidHdrField> s_did_hdr_fields_name_map;

    Header();

    explicit Header(const ctd::file::Yaml& did);

    ~Header();

    void Parse(const ctd::file::Yaml& did);

    std::string GetName() const;

    std::string GetScope() const;

    ctd::defines::IsoTime GetCreationDate() const;

    std::string GetVersion() const;

    const ctd::defines::List<std::string>& GetIncludes() const;

    std::string GetDescription() const;

    std::string Print(DidHdrField fields = DID_HDR_FIELD_ALL,
                      const bool compact = false) const;

private:
    std::string                      m_name;
    std::string                      m_scope;
    ctd::defines::IsoTime            m_creation_date;
    std::string                      m_version;
    ctd::defines::List<std::string>  m_includes;
    std::string                      m_description;
};

} // namespace did
} // namespace dit

#endif // !IFW_DIT_DID_HEADER_HPP_