Date_std_.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/* $Id$
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 */
 
/// @file Date_std_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/general/general.asn">general.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/general/general.def">general.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GENERAL_DATE_STD_BASE_HPP
#define OBJECTS_GENERAL_DATE_STD_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
BEGIN_NCBI_SCOPE
 
#ifndef BEGIN_objects_SCOPE
#  define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
#  define END_objects_SCOPE END_SCOPE(objects)
#endif
BEGIN_objects_SCOPE // namespace ncbi::objects::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_General
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// NOTE: this is NOT a unix tm struct
///
/// CDate_std_Base --
///
 
class NCBI_GENERAL_EXPORT CDate_std_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CDate_std_Base(void);
    // destructor
    virtual ~CDate_std_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TYear;
    typedef int TMonth;
    typedef int TDay;
    typedef string TSeason;
    typedef int THour;
    typedef int TMinute;
    typedef int TSecond;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_year,
        e_month,
        e_day,
        e_season,
        e_hour,
        e_minute,
        e_second
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
 
    // getters
    // setters
 
    /// full year (including 1900)
    /// Check if a value has been assigned to Year data member.
    ///
    /// Data member Year is mandatory;
    /// its type is defined as 'typedef int TYear'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetYear(void) const;
 
    /// Check if it is safe to call GetYear method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetYear(void) const;
 
    /// Reset Year data member.
    void ResetYear(void);
 
    /// Get the Year member data.
    ///
    /// @return
    ///   Copy of the member data.
    TYear GetYear(void) const;
 
    /// Assign a value to Year data member.
    ///
    /// @param value
    ///   Value to assign
    void SetYear(TYear value);
 
    /// Assign a value to Year data member.
    ///
    /// @return
    ///   Reference to the data value.
    TYear& SetYear(void);
 
    /// month (1-12)
    /// Check if a value has been assigned to Month data member.
    ///
    /// Data member Month is optional;
    /// its type is defined as 'typedef int TMonth'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMonth(void) const;
 
    /// Check if it is safe to call GetMonth method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMonth(void) const;
 
    /// Reset Month data member.
    void ResetMonth(void);
 
    /// Get the Month member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMonth GetMonth(void) const;
 
    /// Assign a value to Month data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMonth(TMonth value);
 
    /// Assign a value to Month data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMonth& SetMonth(void);
 
    /// day of month (1-31)
    /// Check if a value has been assigned to Day data member.
    ///
    /// Data member Day is optional;
    /// its type is defined as 'typedef int TDay'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDay(void) const;
 
    /// Check if it is safe to call GetDay method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDay(void) const;
 
    /// Reset Day data member.
    void ResetDay(void);
 
    /// Get the Day member data.
    ///
    /// @return
    ///   Copy of the member data.
    TDay GetDay(void) const;
 
    /// Assign a value to Day data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDay(TDay value);
 
    /// Assign a value to Day data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDay& SetDay(void);
 
    /// for "spring", "may-june", etc
    /// Check if a value has been assigned to Season data member.
    ///
    /// Data member Season is optional;
    /// its type is defined as 'typedef string TSeason'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSeason(void) const;
 
    /// Check if it is safe to call GetSeason method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSeason(void) const;
 
    /// Reset Season data member.
    void ResetSeason(void);
 
    /// Get the Season member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSeason& GetSeason(void) const;
 
    /// Assign a value to Season data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSeason(const TSeason& value);
    void SetSeason(TSeason&& value);
 
    /// Assign a value to Season data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSeason& SetSeason(void);
 
    /// hour of day (0-23)
    /// Check if a value has been assigned to Hour data member.
    ///
    /// Data member Hour is optional;
    /// its type is defined as 'typedef int THour'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetHour(void) const;
 
    /// Check if it is safe to call GetHour method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetHour(void) const;
 
    /// Reset Hour data member.
    void ResetHour(void);
 
    /// Get the Hour member data.
    ///
    /// @return
    ///   Copy of the member data.
    THour GetHour(void) const;
 
    /// Assign a value to Hour data member.
    ///
    /// @param value
    ///   Value to assign
    void SetHour(THour value);
 
    /// Assign a value to Hour data member.
    ///
    /// @return
    ///   Reference to the data value.
    THour& SetHour(void);
 
    /// minute of hour (0-59)
    /// Check if a value has been assigned to Minute data member.
    ///
    /// Data member Minute is optional;
    /// its type is defined as 'typedef int TMinute'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMinute(void) const;
 
    /// Check if it is safe to call GetMinute method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMinute(void) const;
 
    /// Reset Minute data member.
    void ResetMinute(void);
 
    /// Get the Minute member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMinute GetMinute(void) const;
 
    /// Assign a value to Minute data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMinute(TMinute value);
 
    /// Assign a value to Minute data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMinute& SetMinute(void);
 
    /// second of minute (0-59)
    /// Check if a value has been assigned to Second data member.
    ///
    /// Data member Second is optional;
    /// its type is defined as 'typedef int TSecond'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSecond(void) const;
 
    /// Check if it is safe to call GetSecond method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSecond(void) const;
 
    /// Reset Second data member.
    void ResetSecond(void);
 
    /// Get the Second member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSecond GetSecond(void) const;
 
    /// Assign a value to Second data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSecond(TSecond value);
 
    /// Assign a value to Second data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSecond& SetSecond(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CDate_std_Base(const CDate_std_Base&);
    CDate_std_Base& operator=(const CDate_std_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Year;
    int m_Month;
    int m_Day;
    string m_Season;
    int m_Hour;
    int m_Minute;
    int m_Second;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CDate_std_Base::IsSetYear(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CDate_std_Base::CanGetYear(void) const
{
    return IsSetYear();
}
 
inline
void CDate_std_Base::ResetYear(void)
{
    m_Year = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CDate_std_Base::TYear CDate_std_Base::GetYear(void) const
{
    if (!CanGetYear()) {
        ThrowUnassigned(0);
    }
    return m_Year;
}
 
inline
void CDate_std_Base::SetYear(CDate_std_Base::TYear value)
{
    m_Year = value;
    m_set_State[0] |= 0x3;
}
 
inline
CDate_std_Base::TYear& CDate_std_Base::SetYear(void)
{
#ifdef _DEBUG
    if (!IsSetYear()) {
        memset(&m_Year,UnassignedByte(),sizeof(m_Year));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Year;
}
 
inline
bool CDate_std_Base::IsSetMonth(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CDate_std_Base::CanGetMonth(void) const
{
    return IsSetMonth();
}
 
inline
void CDate_std_Base::ResetMonth(void)
{
    m_Month = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CDate_std_Base::TMonth CDate_std_Base::GetMonth(void) const
{
    if (!CanGetMonth()) {
        ThrowUnassigned(1);
    }
    return m_Month;
}
 
inline
void CDate_std_Base::SetMonth(CDate_std_Base::TMonth value)
{
    m_Month = value;
    m_set_State[0] |= 0xc;
}
 
inline
CDate_std_Base::TMonth& CDate_std_Base::SetMonth(void)
{
#ifdef _DEBUG
    if (!IsSetMonth()) {
        memset(&m_Month,UnassignedByte(),sizeof(m_Month));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Month;
}
 
inline
bool CDate_std_Base::IsSetDay(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CDate_std_Base::CanGetDay(void) const
{
    return IsSetDay();
}
 
inline
void CDate_std_Base::ResetDay(void)
{
    m_Day = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CDate_std_Base::TDay CDate_std_Base::GetDay(void) const
{
    if (!CanGetDay()) {
        ThrowUnassigned(2);
    }
    return m_Day;
}
 
inline
void CDate_std_Base::SetDay(CDate_std_Base::TDay value)
{
    m_Day = value;
    m_set_State[0] |= 0x30;
}
 
inline
CDate_std_Base::TDay& CDate_std_Base::SetDay(void)
{
#ifdef _DEBUG
    if (!IsSetDay()) {
        memset(&m_Day,UnassignedByte(),sizeof(m_Day));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Day;
}
 
inline
bool CDate_std_Base::IsSetSeason(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CDate_std_Base::CanGetSeason(void) const
{
    return IsSetSeason();
}
 
inline
const CDate_std_Base::TSeason& CDate_std_Base::GetSeason(void) const
{
    if (!CanGetSeason()) {
        ThrowUnassigned(3);
    }
    return m_Season;
}
 
inline
void CDate_std_Base::SetSeason(const CDate_std_Base::TSeason& value)
{
    m_Season = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CDate_std_Base::SetSeason(CDate_std_Base::TSeason&& value)
{
    m_Season = std::forward<CDate_std_Base::TSeason>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CDate_std_Base::TSeason& CDate_std_Base::SetSeason(void)
{
#ifdef _DEBUG
    if (!IsSetSeason()) {
        m_Season = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Season;
}
 
inline
bool CDate_std_Base::IsSetHour(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CDate_std_Base::CanGetHour(void) const
{
    return IsSetHour();
}
 
inline
void CDate_std_Base::ResetHour(void)
{
    m_Hour = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CDate_std_Base::THour CDate_std_Base::GetHour(void) const
{
    if (!CanGetHour()) {
        ThrowUnassigned(4);
    }
    return m_Hour;
}
 
inline
void CDate_std_Base::SetHour(CDate_std_Base::THour value)
{
    m_Hour = value;
    m_set_State[0] |= 0x300;
}
 
inline
CDate_std_Base::THour& CDate_std_Base::SetHour(void)
{
#ifdef _DEBUG
    if (!IsSetHour()) {
        memset(&m_Hour,UnassignedByte(),sizeof(m_Hour));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Hour;
}
 
inline
bool CDate_std_Base::IsSetMinute(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CDate_std_Base::CanGetMinute(void) const
{
    return IsSetMinute();
}
 
inline
void CDate_std_Base::ResetMinute(void)
{
    m_Minute = 0;
    m_set_State[0] &= ~0xc00;
}
 
inline
CDate_std_Base::TMinute CDate_std_Base::GetMinute(void) const
{
    if (!CanGetMinute()) {
        ThrowUnassigned(5);
    }
    return m_Minute;
}
 
inline
void CDate_std_Base::SetMinute(CDate_std_Base::TMinute value)
{
    m_Minute = value;
    m_set_State[0] |= 0xc00;
}
 
inline
CDate_std_Base::TMinute& CDate_std_Base::SetMinute(void)
{
#ifdef _DEBUG
    if (!IsSetMinute()) {
        memset(&m_Minute,UnassignedByte(),sizeof(m_Minute));
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Minute;
}
 
inline
bool CDate_std_Base::IsSetSecond(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CDate_std_Base::CanGetSecond(void) const
{
    return IsSetSecond();
}
 
inline
void CDate_std_Base::ResetSecond(void)
{
    m_Second = 0;
    m_set_State[0] &= ~0x3000;
}
 
inline
CDate_std_Base::TSecond CDate_std_Base::GetSecond(void) const
{
    if (!CanGetSecond()) {
        ThrowUnassigned(6);
    }
    return m_Second;
}
 
inline
void CDate_std_Base::SetSecond(CDate_std_Base::TSecond value)
{
    m_Second = value;
    m_set_State[0] |= 0x3000;
}
 
inline
CDate_std_Base::TSecond& CDate_std_Base::SetSecond(void)
{
#ifdef _DEBUG
    if (!IsSetSecond()) {
        memset(&m_Second,UnassignedByte(),sizeof(m_Second));
    }
#endif
    m_set_State[0] |= 0x1000;
    return m_Second;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GENERAL_DATE_STD_BASE_HPP