ProjectDescr_.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 ProjectDescr_.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/gbproj/gbproj.asn">gbproj.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/gbproj/gbproj.def">gbproj.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GBPROJ_PROJECTDESCR_BASE_HPP
#define OBJECTS_GBPROJ_PROJECTDESCR_BASE_HPP
 
// extra headers
#include <objects/gbproj/gbproj_export.h>
 
// 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::
 
 
// forward declarations
class CDate;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBProject
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CProjectDescr_Base --
///
 
class NCBI_GBPROJ_EXPORT CProjectDescr_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CProjectDescr_Base(void);
    // destructor
    virtual ~CProjectDescr_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TTitle;
    typedef CDate TCreate_date;
    typedef CDate TModified_date;
    typedef string TComment;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_title,
        e_create_date,
        e_modified_date,
        e_comment
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// user-defined title for the workspace
    /// Check if a value has been assigned to Title data member.
    ///
    /// Data member Title is mandatory;
    /// its type is defined as 'typedef string TTitle'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTitle(void) const;
 
    /// Check if it is safe to call GetTitle method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTitle(void) const;
 
    /// Reset Title data member.
    void ResetTitle(void);
 
    /// Get the Title member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTitle& GetTitle(void) const;
 
    /// Assign a value to Title data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTitle(const TTitle& value);
    void SetTitle(TTitle&& value);
 
    /// Assign a value to Title data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTitle& SetTitle(void);
 
    /// basic (required) descriptors
    /// Check if a value has been assigned to Create_date data member.
    ///
    /// Data member Create_date is mandatory;
    /// its type is defined as 'typedef CDate TCreate_date'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCreate_date(void) const;
 
    /// Check if it is safe to call GetCreate_date method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCreate_date(void) const;
 
    /// Reset Create_date data member.
    void ResetCreate_date(void);
 
    /// Get the Create_date member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCreate_date& GetCreate_date(void) const;
 
    /// Assign a value to Create_date data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetCreate_date(TCreate_date& value);
 
    /// Assign a value to Create_date data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCreate_date& SetCreate_date(void);
 
    /// Check if a value has been assigned to Modified_date data member.
    ///
    /// Data member Modified_date is optional;
    /// its type is defined as 'typedef CDate TModified_date'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetModified_date(void) const;
 
    /// Check if it is safe to call GetModified_date method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetModified_date(void) const;
 
    /// Reset Modified_date data member.
    void ResetModified_date(void);
 
    /// Get the Modified_date member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TModified_date& GetModified_date(void) const;
 
    /// Assign a value to Modified_date data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetModified_date(TModified_date& value);
 
    /// Assign a value to Modified_date data member.
    ///
    /// @return
    ///   Reference to the data value.
    TModified_date& SetModified_date(void);
 
    /// optional descriptors
    /// Check if a value has been assigned to Comment data member.
    ///
    /// Data member Comment is optional;
    /// its type is defined as 'typedef string TComment'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetComment(void) const;
 
    /// Check if it is safe to call GetComment method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetComment(void) const;
 
    /// Reset Comment data member.
    void ResetComment(void);
 
    /// Get the Comment member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TComment& GetComment(void) const;
 
    /// Assign a value to Comment data member.
    ///
    /// @param value
    ///   Value to assign
    void SetComment(const TComment& value);
    void SetComment(TComment&& value);
 
    /// Assign a value to Comment data member.
    ///
    /// @return
    ///   Reference to the data value.
    TComment& SetComment(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CProjectDescr_Base(const CProjectDescr_Base&);
    CProjectDescr_Base& operator=(const CProjectDescr_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Title;
    CRef< TCreate_date > m_Create_date;
    CRef< TModified_date > m_Modified_date;
    string m_Comment;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CProjectDescr_Base::IsSetTitle(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CProjectDescr_Base::CanGetTitle(void) const
{
    return IsSetTitle();
}
 
inline
const CProjectDescr_Base::TTitle& CProjectDescr_Base::GetTitle(void) const
{
    if (!CanGetTitle()) {
        ThrowUnassigned(0);
    }
    return m_Title;
}
 
inline
void CProjectDescr_Base::SetTitle(const CProjectDescr_Base::TTitle& value)
{
    m_Title = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CProjectDescr_Base::SetTitle(CProjectDescr_Base::TTitle&& value)
{
    m_Title = std::forward<CProjectDescr_Base::TTitle>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CProjectDescr_Base::TTitle& CProjectDescr_Base::SetTitle(void)
{
#ifdef _DEBUG
    if (!IsSetTitle()) {
        m_Title = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Title;
}
 
inline
bool CProjectDescr_Base::IsSetCreate_date(void) const
{
    return m_Create_date.NotEmpty();
}
 
inline
bool CProjectDescr_Base::CanGetCreate_date(void) const
{
    return true;
}
 
inline
const CProjectDescr_Base::TCreate_date& CProjectDescr_Base::GetCreate_date(void) const
{
    if ( !m_Create_date ) {
        const_cast<CProjectDescr_Base*>(this)->ResetCreate_date();
    }
    return (*m_Create_date);
}
 
inline
CProjectDescr_Base::TCreate_date& CProjectDescr_Base::SetCreate_date(void)
{
    if ( !m_Create_date ) {
        ResetCreate_date();
    }
    return (*m_Create_date);
}
 
inline
bool CProjectDescr_Base::IsSetModified_date(void) const
{
    return m_Modified_date.NotEmpty();
}
 
inline
bool CProjectDescr_Base::CanGetModified_date(void) const
{
    return IsSetModified_date();
}
 
inline
const CProjectDescr_Base::TModified_date& CProjectDescr_Base::GetModified_date(void) const
{
    if (!CanGetModified_date()) {
        ThrowUnassigned(2);
    }
    return (*m_Modified_date);
}
 
inline
bool CProjectDescr_Base::IsSetComment(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CProjectDescr_Base::CanGetComment(void) const
{
    return IsSetComment();
}
 
inline
const CProjectDescr_Base::TComment& CProjectDescr_Base::GetComment(void) const
{
    if (!CanGetComment()) {
        ThrowUnassigned(3);
    }
    return m_Comment;
}
 
inline
void CProjectDescr_Base::SetComment(const CProjectDescr_Base::TComment& value)
{
    m_Comment = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CProjectDescr_Base::SetComment(CProjectDescr_Base::TComment&& value)
{
    m_Comment = std::forward<CProjectDescr_Base::TComment>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CProjectDescr_Base::TComment& CProjectDescr_Base::SetComment(void)
{
#ifdef _DEBUG
    if (!IsSetComment()) {
        m_Comment = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Comment;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GBPROJ_PROJECTDESCR_BASE_HPP