TMgr_AssemblySpec_.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 TMgr_AssemblySpec_.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/trackmgr/trackmgr.asn">trackmgr.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/trackmgr/trackmgr.def">trackmgr.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_TRACKMGR_TMGR_ASSEMBLYSPEC_BASE_HPP
#define OBJECTS_TRACKMGR_TMGR_ASSEMBLYSPEC_BASE_HPP
 
// extra headers
#include <objects/trackmgr/trackmgr_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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_TrackManager
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CTMgr_AssemblySpec_Base --
///
 
class NCBI_TRACKMGR_EXPORT CTMgr_AssemblySpec_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTMgr_AssemblySpec_Base(void);
    // destructor
    virtual ~CTMgr_AssemblySpec_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Name --
    ///
    
    class NCBI_TRACKMGR_EXPORT C_Name : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Name(void);
        // destructor
        ~C_Name(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef int TTax_id;
        typedef string TName;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_tax_id,
            e_name
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Tax_id data member.
        ///
        /// Data member Tax_id is mandatory;
        /// its type is defined as 'typedef int TTax_id'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetTax_id(void) const;
    
        /// Check if it is safe to call GetTax_id method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetTax_id(void) const;
    
        /// Reset Tax_id data member.
        void ResetTax_id(void);
    
        /// Get the Tax_id member data.
        ///
        /// @return
        ///   Copy of the member data.
        TTax_id GetTax_id(void) const;
    
        /// Assign a value to Tax_id data member.
        ///
        /// @param value
        ///   Value to assign
        void SetTax_id(TTax_id value);
    
        /// Assign a value to Tax_id data member.
        ///
        /// @return
        ///   Reference to the data value.
        TTax_id& SetTax_id(void);
    
        /// Check if a value has been assigned to Name data member.
        ///
        /// Data member Name is mandatory;
        /// its type is defined as 'typedef string TName'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetName(void) const;
    
        /// Check if it is safe to call GetName method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetName(void) const;
    
        /// Reset Name data member.
        void ResetName(void);
    
        /// Get the Name member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TName& GetName(void) const;
    
        /// Assign a value to Name data member.
        ///
        /// @param value
        ///   Value to assign
        void SetName(const TName& value);
        void SetName(TName&& value);
    
        /// Assign a value to Name data member.
        ///
        /// @return
        ///   Reference to the data value.
        TName& SetName(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Name(const C_Name&);
        C_Name& operator=(const C_Name&);
    
        // data
        Uint4 m_set_State[1];
        int m_Tax_id;
        string m_Name;
    };
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,     ///< No variant selected
        e_Name,
        e_Accession,
        e_All_assemblies
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 4 ///< == e_All_assemblies+1
    };
 
    /// Reset the whole object
    virtual void Reset(void);
 
    /// Reset the selection (set it to e_not_set).
    virtual void ResetSelection(void);
 
    /// Which variant is currently selected.
    ///
    /// @return
    ///   Choice state enumerator.
    E_Choice Which(void) const;
 
    /// Verify selection, throw exception if it differs from the expected.
    ///
    /// @param index
    ///   Expected selection.
    void CheckSelected(E_Choice index) const;
 
    /// Throw 'InvalidSelection' exception.
    ///
    /// @param index
    ///   Expected selection.
    NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
 
    /// Retrieve selection name (for diagnostic purposes).
    ///
    /// @param index
    ///   One of possible selection states.
    /// @return
    ///   Name string.
    static string SelectionName(E_Choice index);
 
    /// Select the requested variant if needed.
    ///
    /// @param index
    ///   New selection state.
    /// @param reset
    ///   Flag that defines the resetting of the variant data. The data will
    ///   be reset if either the current selection differs from the new one,
    ///   or the flag is set to eDoResetVariant.
    void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
    /// Select the requested variant if needed,
    /// allocating CObject variants from memory pool.
    void Select(E_Choice index,
                EResetVariant reset,
                CObjectMemoryPool* pool);
 
    // types
    typedef C_Name TName;
    typedef string TAccession;
 
    // getters
    // setters
 
 
    /// Check if variant Name is selected.
    ///
    /// Name type is defined as 'typedef C_Name TName'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsName(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TName& GetName(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TName& SetName(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetName(TName& value);
 
 
    /// Check if variant Accession is selected.
    ///
    /// Accession type is defined as 'typedef string TAccession'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAccession(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TAccession& GetAccession(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TAccession& SetAccession(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetAccession(const TAccession& value);
 
 
    /// Check if variant All_assemblies is selected.
    ///
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAll_assemblies(void) const;
 
    /// Select the variant.
    void SetAll_assemblies(void);
 
 
private:
    // copy constructor and assignment operator
    CTMgr_AssemblySpec_Base(const CTMgr_AssemblySpec_Base& );
    CTMgr_AssemblySpec_Base& operator=(const CTMgr_AssemblySpec_Base& );
    // choice state
    E_Choice m_choice;
    // helper methods
    void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
 
    static const char* const sm_SelectionNames[];
    // data
    union {
        NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CTMgr_AssemblySpec_Base::C_Name::IsSetTax_id(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CTMgr_AssemblySpec_Base::C_Name::CanGetTax_id(void) const
{
    return IsSetTax_id();
}
 
inline
void CTMgr_AssemblySpec_Base::C_Name::ResetTax_id(void)
{
    m_Tax_id = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CTMgr_AssemblySpec_Base::C_Name::TTax_id CTMgr_AssemblySpec_Base::C_Name::GetTax_id(void) const
{
    if (!CanGetTax_id()) {
        ThrowUnassigned(0);
    }
    return m_Tax_id;
}
 
inline
void CTMgr_AssemblySpec_Base::C_Name::SetTax_id(CTMgr_AssemblySpec_Base::C_Name::TTax_id value)
{
    m_Tax_id = value;
    m_set_State[0] |= 0x3;
}
 
inline
CTMgr_AssemblySpec_Base::C_Name::TTax_id& CTMgr_AssemblySpec_Base::C_Name::SetTax_id(void)
{
#ifdef _DEBUG
    if (!IsSetTax_id()) {
        memset(&m_Tax_id,UnassignedByte(),sizeof(m_Tax_id));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Tax_id;
}
 
inline
bool CTMgr_AssemblySpec_Base::C_Name::IsSetName(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CTMgr_AssemblySpec_Base::C_Name::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CTMgr_AssemblySpec_Base::C_Name::TName& CTMgr_AssemblySpec_Base::C_Name::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(1);
    }
    return m_Name;
}
 
inline
void CTMgr_AssemblySpec_Base::C_Name::SetName(const CTMgr_AssemblySpec_Base::C_Name::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CTMgr_AssemblySpec_Base::C_Name::SetName(CTMgr_AssemblySpec_Base::C_Name::TName&& value)
{
    m_Name = std::forward<CTMgr_AssemblySpec_Base::C_Name::TName>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CTMgr_AssemblySpec_Base::C_Name::TName& CTMgr_AssemblySpec_Base::C_Name::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Name;
}
 
inline
CTMgr_AssemblySpec_Base::E_Choice CTMgr_AssemblySpec_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CTMgr_AssemblySpec_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CTMgr_AssemblySpec_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CTMgr_AssemblySpec_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CTMgr_AssemblySpec_Base::IsName(void) const
{
    return m_choice == e_Name;
}
 
inline
bool CTMgr_AssemblySpec_Base::IsAccession(void) const
{
    return m_choice == e_Accession;
}
 
inline
const CTMgr_AssemblySpec_Base::TAccession& CTMgr_AssemblySpec_Base::GetAccession(void) const
{
    CheckSelected(e_Accession);
    return *m_string;
}
 
inline
CTMgr_AssemblySpec_Base::TAccession& CTMgr_AssemblySpec_Base::SetAccession(void)
{
    Select(e_Accession, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CTMgr_AssemblySpec_Base::IsAll_assemblies(void) const
{
    return m_choice == e_All_assemblies;
}
 
inline
void CTMgr_AssemblySpec_Base::SetAll_assemblies(void)
{
    Select(e_All_assemblies, NCBI_NS_NCBI::eDoNotResetVariant);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_TRACKMGR_TMGR_ASSEMBLYSPEC_BASE_HPP