Field_type_.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 Field_type_.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/macro/macro.asn">macro.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/macro/macro.def">macro.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MACRO_FIELD_TYPE_BASE_HPP
#define OBJECTS_MACRO_FIELD_TYPE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <objects/macro/CDSGeneProt_field.hpp>
#include <objects/macro/DBLink_field_type.hpp>
#include <objects/macro/Misc_field.hpp>
#include <objects/macro/Publication_field.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::
 
 
// forward declarations
class CFeature_field;
class CMolinfo_field;
class CRna_qual;
class CSource_qual_choice;
class CStructured_comment_field;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Macro
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CField_type_Base --
///
 
class CField_type_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CField_type_Base(void);
    // destructor
    virtual ~CField_type_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,          ///< No variant selected
        e_Source_qual,
        e_Feature_field,
        e_Rna_field,
        e_Cds_gene_prot,
        e_Molinfo_field,
        e_Pub,
        e_Struc_comment_field,
        e_Misc,
        e_Dblink
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 10 ///< == e_Dblink+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 CSource_qual_choice TSource_qual;
    typedef CFeature_field TFeature_field;
    typedef CRna_qual TRna_field;
    typedef ECDSGeneProt_field TCds_gene_prot;
    typedef CMolinfo_field TMolinfo_field;
    typedef EPublication_field TPub;
    typedef CStructured_comment_field TStruc_comment_field;
    typedef EMisc_field TMisc;
    typedef EDBLink_field_type TDblink;
 
    // getters
    // setters
 
 
    /// Check if variant Source_qual is selected.
    ///
    /// Source_qual type is defined as 'typedef CSource_qual_choice TSource_qual'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsSource_qual(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TSource_qual& GetSource_qual(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TSource_qual& SetSource_qual(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetSource_qual(TSource_qual& value);
 
 
    /// Check if variant Feature_field is selected.
    ///
    /// Feature_field type is defined as 'typedef CFeature_field TFeature_field'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsFeature_field(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TFeature_field& GetFeature_field(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TFeature_field& SetFeature_field(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetFeature_field(TFeature_field& value);
 
 
    /// Check if variant Rna_field is selected.
    ///
    /// Rna_field type is defined as 'typedef CRna_qual TRna_field'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsRna_field(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TRna_field& GetRna_field(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TRna_field& SetRna_field(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetRna_field(TRna_field& value);
 
 
    /// Check if variant Cds_gene_prot is selected.
    ///
    /// Cds_gene_prot type is defined as 'typedef ECDSGeneProt_field TCds_gene_prot'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsCds_gene_prot(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TCds_gene_prot GetCds_gene_prot(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TCds_gene_prot& SetCds_gene_prot(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetCds_gene_prot(TCds_gene_prot value);
 
 
    /// Check if variant Molinfo_field is selected.
    ///
    /// Molinfo_field type is defined as 'typedef CMolinfo_field TMolinfo_field'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsMolinfo_field(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TMolinfo_field& GetMolinfo_field(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TMolinfo_field& SetMolinfo_field(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetMolinfo_field(TMolinfo_field& value);
 
 
    /// Check if variant Pub is selected.
    ///
    /// Pub type is defined as 'typedef EPublication_field TPub'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsPub(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TPub GetPub(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TPub& SetPub(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetPub(TPub value);
 
 
    /// Check if variant Struc_comment_field is selected.
    ///
    /// Struc_comment_field type is defined as 'typedef CStructured_comment_field TStruc_comment_field'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsStruc_comment_field(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TStruc_comment_field& GetStruc_comment_field(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TStruc_comment_field& SetStruc_comment_field(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetStruc_comment_field(TStruc_comment_field& value);
 
 
    /// Check if variant Misc is selected.
    ///
    /// Misc type is defined as 'typedef EMisc_field TMisc'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsMisc(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TMisc GetMisc(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TMisc& SetMisc(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetMisc(TMisc value);
 
 
    /// Check if variant Dblink is selected.
    ///
    /// Dblink type is defined as 'typedef EDBLink_field_type TDblink'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsDblink(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TDblink GetDblink(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TDblink& SetDblink(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetDblink(TDblink value);
 
 
private:
    // copy constructor and assignment operator
    CField_type_Base(const CField_type_Base& );
    CField_type_Base& operator=(const CField_type_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 {
        TCds_gene_prot m_Cds_gene_prot;
        TPub m_Pub;
        TMisc m_Misc;
        TDblink m_Dblink;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CField_type_Base::E_Choice CField_type_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CField_type_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CField_type_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 CField_type_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CField_type_Base::IsSource_qual(void) const
{
    return m_choice == e_Source_qual;
}
 
inline
bool CField_type_Base::IsFeature_field(void) const
{
    return m_choice == e_Feature_field;
}
 
inline
bool CField_type_Base::IsRna_field(void) const
{
    return m_choice == e_Rna_field;
}
 
inline
bool CField_type_Base::IsCds_gene_prot(void) const
{
    return m_choice == e_Cds_gene_prot;
}
 
inline
CField_type_Base::TCds_gene_prot CField_type_Base::GetCds_gene_prot(void) const
{
    CheckSelected(e_Cds_gene_prot);
    return m_Cds_gene_prot;
}
 
inline
CField_type_Base::TCds_gene_prot& CField_type_Base::SetCds_gene_prot(void)
{
    Select(e_Cds_gene_prot, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Cds_gene_prot;
}
 
inline
void CField_type_Base::SetCds_gene_prot(CField_type_Base::TCds_gene_prot value)
{
    Select(e_Cds_gene_prot, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Cds_gene_prot = value;
}
 
inline
bool CField_type_Base::IsMolinfo_field(void) const
{
    return m_choice == e_Molinfo_field;
}
 
inline
bool CField_type_Base::IsPub(void) const
{
    return m_choice == e_Pub;
}
 
inline
CField_type_Base::TPub CField_type_Base::GetPub(void) const
{
    CheckSelected(e_Pub);
    return m_Pub;
}
 
inline
CField_type_Base::TPub& CField_type_Base::SetPub(void)
{
    Select(e_Pub, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Pub;
}
 
inline
void CField_type_Base::SetPub(CField_type_Base::TPub value)
{
    Select(e_Pub, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Pub = value;
}
 
inline
bool CField_type_Base::IsStruc_comment_field(void) const
{
    return m_choice == e_Struc_comment_field;
}
 
inline
bool CField_type_Base::IsMisc(void) const
{
    return m_choice == e_Misc;
}
 
inline
CField_type_Base::TMisc CField_type_Base::GetMisc(void) const
{
    CheckSelected(e_Misc);
    return m_Misc;
}
 
inline
CField_type_Base::TMisc& CField_type_Base::SetMisc(void)
{
    Select(e_Misc, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Misc;
}
 
inline
void CField_type_Base::SetMisc(CField_type_Base::TMisc value)
{
    Select(e_Misc, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Misc = value;
}
 
inline
bool CField_type_Base::IsDblink(void) const
{
    return m_choice == e_Dblink;
}
 
inline
CField_type_Base::TDblink CField_type_Base::GetDblink(void) const
{
    CheckSelected(e_Dblink);
    return m_Dblink;
}
 
inline
CField_type_Base::TDblink& CField_type_Base::SetDblink(void)
{
    Select(e_Dblink, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Dblink;
}
 
inline
void CField_type_Base::SetDblink(CField_type_Base::TDblink value)
{
    Select(e_Dblink, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Dblink = value;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MACRO_FIELD_TYPE_BASE_HPP