GCClient_AssemblyInfo_.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 GCClient_AssemblyInfo_.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/genomecoll/gencoll_client.asn">gencoll_client.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/genomecoll/gencoll_client.def">gencoll_client.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GENOMECOLL_GCCLIENT_ASSEMBLYINFO_BASE_HPP
#define OBJECTS_GENOMECOLL_GCCLIENT_ASSEMBLYINFO_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_GencollClient
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGCClient_AssemblyInfo_Base --
///
 
class CGCClient_AssemblyInfo_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGCClient_AssemblyInfo_Base(void);
    // destructor
    virtual ~CGCClient_AssemblyInfo_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    enum EType {
        eType_genbank = 1,
        eType_refseq  = 2
    };
    
    /// Access to EType's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EType)(void);
    
    // types
    typedef string TAccession;
    typedef bool TLatest;
    typedef bool TMajor;
    typedef bool TAnnotated;
    typedef int TType;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_accession,
        e_latest,
        e_major,
        e_annotated,
        e_type
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Accession data member.
    ///
    /// Data member Accession is mandatory;
    /// its type is defined as 'typedef string TAccession'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAccession(void) const;
 
    /// Check if it is safe to call GetAccession method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAccession(void) const;
 
    /// Reset Accession data member.
    void ResetAccession(void);
 
    /// Get the Accession member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAccession& GetAccession(void) const;
 
    /// Assign a value to Accession data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAccession(const TAccession& value);
    void SetAccession(TAccession&& value);
 
    /// Assign a value to Accession data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAccession& SetAccession(void);
 
    /// Check if a value has been assigned to Latest data member.
    ///
    /// Data member Latest is mandatory;
    /// its type is defined as 'typedef bool TLatest'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLatest(void) const;
 
    /// Check if it is safe to call GetLatest method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLatest(void) const;
 
    /// Reset Latest data member.
    void ResetLatest(void);
 
    /// Get the Latest member data.
    ///
    /// @return
    ///   Copy of the member data.
    TLatest GetLatest(void) const;
 
    /// Assign a value to Latest data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLatest(TLatest value);
 
    /// Assign a value to Latest data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLatest& SetLatest(void);
 
    /// Check if a value has been assigned to Major data member.
    ///
    /// Data member Major is mandatory;
    /// its type is defined as 'typedef bool TMajor'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMajor(void) const;
 
    /// Check if it is safe to call GetMajor method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMajor(void) const;
 
    /// Reset Major data member.
    void ResetMajor(void);
 
    /// Get the Major member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMajor GetMajor(void) const;
 
    /// Assign a value to Major data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMajor(TMajor value);
 
    /// Assign a value to Major data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMajor& SetMajor(void);
 
    /// Check if a value has been assigned to Annotated data member.
    ///
    /// Data member Annotated is optional;
    /// its type is defined as 'typedef bool TAnnotated'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAnnotated(void) const;
 
    /// Check if it is safe to call GetAnnotated method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAnnotated(void) const;
 
    /// Reset Annotated data member.
    void ResetAnnotated(void);
 
    /// Get the Annotated member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAnnotated GetAnnotated(void) const;
 
    /// Assign a value to Annotated data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAnnotated(TAnnotated value);
 
    /// Assign a value to Annotated data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAnnotated& SetAnnotated(void);
 
    /// Check if a value has been assigned to Type data member.
    ///
    /// Data member Type is optional;
    /// its type is defined as 'typedef int TType'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetType(void) const;
 
    /// Check if it is safe to call GetType method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetType(void) const;
 
    /// Reset Type data member.
    void ResetType(void);
 
    /// Get the Type member data.
    ///
    /// @return
    ///   Copy of the member data.
    TType GetType(void) const;
 
    /// Assign a value to Type data member.
    ///
    /// @param value
    ///   Value to assign
    void SetType(TType value);
 
    /// Assign a value to Type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TType& SetType(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGCClient_AssemblyInfo_Base(const CGCClient_AssemblyInfo_Base&);
    CGCClient_AssemblyInfo_Base& operator=(const CGCClient_AssemblyInfo_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Accession;
    bool m_Latest;
    bool m_Major;
    bool m_Annotated;
    int m_Type;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGCClient_AssemblyInfo_Base::IsSetAccession(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGCClient_AssemblyInfo_Base::CanGetAccession(void) const
{
    return IsSetAccession();
}
 
inline
const CGCClient_AssemblyInfo_Base::TAccession& CGCClient_AssemblyInfo_Base::GetAccession(void) const
{
    if (!CanGetAccession()) {
        ThrowUnassigned(0);
    }
    return m_Accession;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetAccession(const CGCClient_AssemblyInfo_Base::TAccession& value)
{
    m_Accession = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetAccession(CGCClient_AssemblyInfo_Base::TAccession&& value)
{
    m_Accession = std::forward<CGCClient_AssemblyInfo_Base::TAccession>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CGCClient_AssemblyInfo_Base::TAccession& CGCClient_AssemblyInfo_Base::SetAccession(void)
{
#ifdef _DEBUG
    if (!IsSetAccession()) {
        m_Accession = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Accession;
}
 
inline
bool CGCClient_AssemblyInfo_Base::IsSetLatest(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGCClient_AssemblyInfo_Base::CanGetLatest(void) const
{
    return IsSetLatest();
}
 
inline
void CGCClient_AssemblyInfo_Base::ResetLatest(void)
{
    m_Latest = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CGCClient_AssemblyInfo_Base::TLatest CGCClient_AssemblyInfo_Base::GetLatest(void) const
{
    if (!CanGetLatest()) {
        ThrowUnassigned(1);
    }
    return m_Latest;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetLatest(CGCClient_AssemblyInfo_Base::TLatest value)
{
    m_Latest = value;
    m_set_State[0] |= 0xc;
}
 
inline
CGCClient_AssemblyInfo_Base::TLatest& CGCClient_AssemblyInfo_Base::SetLatest(void)
{
#ifdef _DEBUG
    if (!IsSetLatest()) {
        memset(&m_Latest,UnassignedByte(),sizeof(m_Latest));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Latest;
}
 
inline
bool CGCClient_AssemblyInfo_Base::IsSetMajor(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGCClient_AssemblyInfo_Base::CanGetMajor(void) const
{
    return IsSetMajor();
}
 
inline
void CGCClient_AssemblyInfo_Base::ResetMajor(void)
{
    m_Major = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CGCClient_AssemblyInfo_Base::TMajor CGCClient_AssemblyInfo_Base::GetMajor(void) const
{
    if (!CanGetMajor()) {
        ThrowUnassigned(2);
    }
    return m_Major;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetMajor(CGCClient_AssemblyInfo_Base::TMajor value)
{
    m_Major = value;
    m_set_State[0] |= 0x30;
}
 
inline
CGCClient_AssemblyInfo_Base::TMajor& CGCClient_AssemblyInfo_Base::SetMajor(void)
{
#ifdef _DEBUG
    if (!IsSetMajor()) {
        memset(&m_Major,UnassignedByte(),sizeof(m_Major));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Major;
}
 
inline
bool CGCClient_AssemblyInfo_Base::IsSetAnnotated(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGCClient_AssemblyInfo_Base::CanGetAnnotated(void) const
{
    return IsSetAnnotated();
}
 
inline
void CGCClient_AssemblyInfo_Base::ResetAnnotated(void)
{
    m_Annotated = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CGCClient_AssemblyInfo_Base::TAnnotated CGCClient_AssemblyInfo_Base::GetAnnotated(void) const
{
    if (!CanGetAnnotated()) {
        ThrowUnassigned(3);
    }
    return m_Annotated;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetAnnotated(CGCClient_AssemblyInfo_Base::TAnnotated value)
{
    m_Annotated = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CGCClient_AssemblyInfo_Base::TAnnotated& CGCClient_AssemblyInfo_Base::SetAnnotated(void)
{
#ifdef _DEBUG
    if (!IsSetAnnotated()) {
        memset(&m_Annotated,UnassignedByte(),sizeof(m_Annotated));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Annotated;
}
 
inline
bool CGCClient_AssemblyInfo_Base::IsSetType(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGCClient_AssemblyInfo_Base::CanGetType(void) const
{
    return IsSetType();
}
 
inline
void CGCClient_AssemblyInfo_Base::ResetType(void)
{
    m_Type = (EType)(0);
    m_set_State[0] &= ~0x300;
}
 
inline
CGCClient_AssemblyInfo_Base::TType CGCClient_AssemblyInfo_Base::GetType(void) const
{
    if (!CanGetType()) {
        ThrowUnassigned(4);
    }
    return m_Type;
}
 
inline
void CGCClient_AssemblyInfo_Base::SetType(CGCClient_AssemblyInfo_Base::TType value)
{
    m_Type = value;
    m_set_State[0] |= 0x300;
}
 
inline
CGCClient_AssemblyInfo_Base::TType& CGCClient_AssemblyInfo_Base::SetType(void)
{
#ifdef _DEBUG
    if (!IsSetType()) {
        memset(&m_Type,UnassignedByte(),sizeof(m_Type));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Type;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GENOMECOLL_GCCLIENT_ASSEMBLYINFO_BASE_HPP