Trna_ext_.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 Trna_ext_.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/seqfeat/seqfeat.asn">seqfeat.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqfeat/seqfeat.def">seqfeat.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQFEAT_TRNA_EXT_BASE_HPP
#define OBJECTS_SEQFEAT_TRNA_EXT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
 
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 CSeq_loc;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_RNA
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// tRNA feature extensions
///
/// CTrna_ext_Base --
///
 
class NCBI_SEQFEAT_EXPORT CTrna_ext_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTrna_ext_Base(void);
    // destructor
    virtual ~CTrna_ext_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    /// aa this carries
    ///
    /// C_Aa --
    ///
    
    class NCBI_SEQFEAT_EXPORT C_Aa : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Aa(void);
        // destructor
        ~C_Aa(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    
        /// Choice variants.
        enum E_Choice {
            e_not_set = 0,  ///< No variant selected
            e_Iupacaa,
            e_Ncbieaa,
            e_Ncbi8aa,
            e_Ncbistdaa
        };
        /// Maximum+1 value of the choice variant enumerator.
        enum E_ChoiceStopper {
            e_MaxChoice = 5 ///< == e_Ncbistdaa+1
        };
    
        /// Reset the whole object
        void Reset(void);
    
        /// Reset the selection (set it to e_not_set).
        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 int TIupacaa;
        typedef int TNcbieaa;
        typedef int TNcbi8aa;
        typedef int TNcbistdaa;
    
        // getters
        // setters
    
    
        /// Check if variant Iupacaa is selected.
        ///
        /// Iupacaa type is defined as 'typedef int TIupacaa'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsIupacaa(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Copy of the variant data.
        TIupacaa GetIupacaa(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TIupacaa& SetIupacaa(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetIupacaa(TIupacaa value);
    
    
        /// Check if variant Ncbieaa is selected.
        ///
        /// Ncbieaa type is defined as 'typedef int TNcbieaa'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsNcbieaa(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Copy of the variant data.
        TNcbieaa GetNcbieaa(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TNcbieaa& SetNcbieaa(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetNcbieaa(TNcbieaa value);
    
    
        /// Check if variant Ncbi8aa is selected.
        ///
        /// Ncbi8aa type is defined as 'typedef int TNcbi8aa'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsNcbi8aa(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Copy of the variant data.
        TNcbi8aa GetNcbi8aa(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TNcbi8aa& SetNcbi8aa(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetNcbi8aa(TNcbi8aa value);
    
    
        /// Check if variant Ncbistdaa is selected.
        ///
        /// Ncbistdaa type is defined as 'typedef int TNcbistdaa'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsNcbistdaa(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Copy of the variant data.
        TNcbistdaa GetNcbistdaa(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TNcbistdaa& SetNcbistdaa(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetNcbistdaa(TNcbistdaa value);
    
    
    private:
        // copy constructor and assignment operator
        C_Aa(const C_Aa& );
        C_Aa& operator=(const C_Aa& );
        // choice state
        E_Choice m_choice;
        // helper methods
        void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
    
        static const char* const sm_SelectionNames[];
        // data
        union {
            TIupacaa m_Iupacaa;
            TNcbieaa m_Ncbieaa;
            TNcbi8aa m_Ncbi8aa;
            TNcbistdaa m_Ncbistdaa;
        };
    };
    // types
    typedef C_Aa TAa;
    typedef list< int > TCodon;
    typedef CSeq_loc TAnticodon;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_aa,
        e_codon,
        e_anticodon
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Aa data member.
    ///
    /// Data member Aa is optional;
    /// its type is defined as 'typedef C_Aa TAa'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAa(void) const;
 
    /// Check if it is safe to call GetAa method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAa(void) const;
 
    /// Reset Aa data member.
    void ResetAa(void);
 
    /// Get the Aa member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAa& GetAa(void) const;
 
    /// Assign a value to Aa data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAa(TAa& value);
 
    /// Assign a value to Aa data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAa& SetAa(void);
 
    /// codon(s) as in Genetic-code
    /// Check if a value has been assigned to Codon data member.
    ///
    /// Data member Codon is optional;
    /// its type is defined as 'typedef list< int > TCodon'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCodon(void) const;
 
    /// Check if it is safe to call GetCodon method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCodon(void) const;
 
    /// Reset Codon data member.
    void ResetCodon(void);
 
    /// Get the Codon member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCodon& GetCodon(void) const;
 
    /// Assign a value to Codon data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCodon& SetCodon(void);
 
    /// location of anticodon
    /// Check if a value has been assigned to Anticodon data member.
    ///
    /// Data member Anticodon is optional;
    /// its type is defined as 'typedef CSeq_loc TAnticodon'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAnticodon(void) const;
 
    /// Check if it is safe to call GetAnticodon method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAnticodon(void) const;
 
    /// Reset Anticodon data member.
    void ResetAnticodon(void);
 
    /// Get the Anticodon member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAnticodon& GetAnticodon(void) const;
 
    /// Assign a value to Anticodon data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAnticodon(TAnticodon& value);
 
    /// Assign a value to Anticodon data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAnticodon& SetAnticodon(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CTrna_ext_Base(const CTrna_ext_Base&);
    CTrna_ext_Base& operator=(const CTrna_ext_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAa > m_Aa;
    list< int > m_Codon;
    CRef< TAnticodon > m_Anticodon;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CTrna_ext_Base::C_Aa::E_Choice CTrna_ext_Base::C_Aa::Which(void) const
{
    return m_choice;
}
 
inline
void CTrna_ext_Base::C_Aa::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CTrna_ext_Base::C_Aa::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 CTrna_ext_Base::C_Aa::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CTrna_ext_Base::C_Aa::IsIupacaa(void) const
{
    return m_choice == e_Iupacaa;
}
 
inline
CTrna_ext_Base::C_Aa::TIupacaa CTrna_ext_Base::C_Aa::GetIupacaa(void) const
{
    CheckSelected(e_Iupacaa);
    return m_Iupacaa;
}
 
inline
CTrna_ext_Base::C_Aa::TIupacaa& CTrna_ext_Base::C_Aa::SetIupacaa(void)
{
    Select(e_Iupacaa, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Iupacaa;
}
 
inline
void CTrna_ext_Base::C_Aa::SetIupacaa(CTrna_ext_Base::C_Aa::TIupacaa value)
{
    Select(e_Iupacaa, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Iupacaa = value;
}
 
inline
bool CTrna_ext_Base::C_Aa::IsNcbieaa(void) const
{
    return m_choice == e_Ncbieaa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbieaa CTrna_ext_Base::C_Aa::GetNcbieaa(void) const
{
    CheckSelected(e_Ncbieaa);
    return m_Ncbieaa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbieaa& CTrna_ext_Base::C_Aa::SetNcbieaa(void)
{
    Select(e_Ncbieaa, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Ncbieaa;
}
 
inline
void CTrna_ext_Base::C_Aa::SetNcbieaa(CTrna_ext_Base::C_Aa::TNcbieaa value)
{
    Select(e_Ncbieaa, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Ncbieaa = value;
}
 
inline
bool CTrna_ext_Base::C_Aa::IsNcbi8aa(void) const
{
    return m_choice == e_Ncbi8aa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbi8aa CTrna_ext_Base::C_Aa::GetNcbi8aa(void) const
{
    CheckSelected(e_Ncbi8aa);
    return m_Ncbi8aa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbi8aa& CTrna_ext_Base::C_Aa::SetNcbi8aa(void)
{
    Select(e_Ncbi8aa, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Ncbi8aa;
}
 
inline
void CTrna_ext_Base::C_Aa::SetNcbi8aa(CTrna_ext_Base::C_Aa::TNcbi8aa value)
{
    Select(e_Ncbi8aa, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Ncbi8aa = value;
}
 
inline
bool CTrna_ext_Base::C_Aa::IsNcbistdaa(void) const
{
    return m_choice == e_Ncbistdaa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbistdaa CTrna_ext_Base::C_Aa::GetNcbistdaa(void) const
{
    CheckSelected(e_Ncbistdaa);
    return m_Ncbistdaa;
}
 
inline
CTrna_ext_Base::C_Aa::TNcbistdaa& CTrna_ext_Base::C_Aa::SetNcbistdaa(void)
{
    Select(e_Ncbistdaa, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Ncbistdaa;
}
 
inline
void CTrna_ext_Base::C_Aa::SetNcbistdaa(CTrna_ext_Base::C_Aa::TNcbistdaa value)
{
    Select(e_Ncbistdaa, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Ncbistdaa = value;
}
 
inline
bool CTrna_ext_Base::IsSetAa(void) const
{
    return m_Aa.NotEmpty();
}
 
inline
bool CTrna_ext_Base::CanGetAa(void) const
{
    return IsSetAa();
}
 
inline
const CTrna_ext_Base::TAa& CTrna_ext_Base::GetAa(void) const
{
    if (!CanGetAa()) {
        ThrowUnassigned(0);
    }
    return (*m_Aa);
}
 
inline
bool CTrna_ext_Base::IsSetCodon(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CTrna_ext_Base::CanGetCodon(void) const
{
    return true;
}
 
inline
const CTrna_ext_Base::TCodon& CTrna_ext_Base::GetCodon(void) const
{
    return m_Codon;
}
 
inline
CTrna_ext_Base::TCodon& CTrna_ext_Base::SetCodon(void)
{
    m_set_State[0] |= 0x4;
    return m_Codon;
}
 
inline
bool CTrna_ext_Base::IsSetAnticodon(void) const
{
    return m_Anticodon.NotEmpty();
}
 
inline
bool CTrna_ext_Base::CanGetAnticodon(void) const
{
    return IsSetAnticodon();
}
 
inline
const CTrna_ext_Base::TAnticodon& CTrna_ext_Base::GetAnticodon(void) const
{
    if (!CanGetAnticodon()) {
        ThrowUnassigned(2);
    }
    return (*m_Anticodon);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQFEAT_TRNA_EXT_BASE_HPP