Mim_date_.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 Mim_date_.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/mim/mim.asn">mim.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mim/mim.def">mim.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MIM_MIM_DATE_BASE_HPP
#define OBJECTS_MIM_MIM_DATE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
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_Mim
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CMim_date_Base --
///
 
class NCBI_MIM_EXPORT CMim_date_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMim_date_Base(void);
    // destructor
    virtual ~CMim_date_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TYear;
    typedef int TMonth;
    typedef int TDay;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_year,
        e_month,
        e_day
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// 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);
 
    /// 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);
 
    /// 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);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMim_date_Base(const CMim_date_Base&);
    CMim_date_Base& operator=(const CMim_date_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Year;
    int m_Month;
    int m_Day;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMim_date_Base::IsSetYear(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CMim_date_Base::CanGetYear(void) const
{
    return IsSetYear();
}
 
inline
void CMim_date_Base::ResetYear(void)
{
    m_Year = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CMim_date_Base::TYear CMim_date_Base::GetYear(void) const
{
    if (!CanGetYear()) {
        ThrowUnassigned(0);
    }
    return m_Year;
}
 
inline
void CMim_date_Base::SetYear(CMim_date_Base::TYear value)
{
    m_Year = value;
    m_set_State[0] |= 0x3;
}
 
inline
CMim_date_Base::TYear& CMim_date_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 CMim_date_Base::IsSetMonth(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMim_date_Base::CanGetMonth(void) const
{
    return IsSetMonth();
}
 
inline
void CMim_date_Base::ResetMonth(void)
{
    m_Month = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CMim_date_Base::TMonth CMim_date_Base::GetMonth(void) const
{
    if (!CanGetMonth()) {
        ThrowUnassigned(1);
    }
    return m_Month;
}
 
inline
void CMim_date_Base::SetMonth(CMim_date_Base::TMonth value)
{
    m_Month = value;
    m_set_State[0] |= 0xc;
}
 
inline
CMim_date_Base::TMonth& CMim_date_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 CMim_date_Base::IsSetDay(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CMim_date_Base::CanGetDay(void) const
{
    return IsSetDay();
}
 
inline
void CMim_date_Base::ResetDay(void)
{
    m_Day = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CMim_date_Base::TDay CMim_date_Base::GetDay(void) const
{
    if (!CanGetDay()) {
        ThrowUnassigned(2);
    }
    return m_Day;
}
 
inline
void CMim_date_Base::SetDay(CMim_date_Base::TDay value)
{
    m_Day = value;
    m_set_State[0] |= 0x30;
}
 
inline
CMim_date_Base::TDay& CMim_date_Base::SetDay(void)
{
#ifdef _DEBUG
    if (!IsSetDay()) {
        memset(&m_Day,UnassignedByte(),sizeof(m_Day));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Day;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MIM_MIM_DATE_BASE_HPP