Convert_from_CDS_options_.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 Convert_from_CDS_options_.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_CONVERT_FROM_CDS_OPTIONS_BASE_HPP
#define OBJECTS_MACRO_CONVERT_FROM_CDS_OPTIONS_BASE_HPP
 
// standard includes
#include <serial/serialbase.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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Macro
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// for convert features 
///
/// CConvert_from_CDS_options_Base --
///
 
class CConvert_from_CDS_options_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CConvert_from_CDS_options_Base(void);
    // destructor
    virtual ~CConvert_from_CDS_options_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef bool TRemove_mRNA;
    typedef bool TRemove_gene;
    typedef bool TRemove_transcript_id;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_remove_mRNA,
        e_remove_gene,
        e_remove_transcript_id
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Remove_mRNA data member.
    ///
    /// Data member Remove_mRNA is mandatory;
    /// its type is defined as 'typedef bool TRemove_mRNA'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRemove_mRNA(void) const;
 
    /// Check if it is safe to call GetRemove_mRNA method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRemove_mRNA(void) const;
 
    /// Reset Remove_mRNA data member.
    void ResetRemove_mRNA(void);
 
    /// Get the Remove_mRNA member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRemove_mRNA GetRemove_mRNA(void) const;
 
    /// Assign a value to Remove_mRNA data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRemove_mRNA(TRemove_mRNA value);
 
    /// Assign a value to Remove_mRNA data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRemove_mRNA& SetRemove_mRNA(void);
 
    /// Check if a value has been assigned to Remove_gene data member.
    ///
    /// Data member Remove_gene is mandatory;
    /// its type is defined as 'typedef bool TRemove_gene'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRemove_gene(void) const;
 
    /// Check if it is safe to call GetRemove_gene method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRemove_gene(void) const;
 
    /// Reset Remove_gene data member.
    void ResetRemove_gene(void);
 
    /// Get the Remove_gene member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRemove_gene GetRemove_gene(void) const;
 
    /// Assign a value to Remove_gene data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRemove_gene(TRemove_gene value);
 
    /// Assign a value to Remove_gene data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRemove_gene& SetRemove_gene(void);
 
    /// Check if a value has been assigned to Remove_transcript_id data member.
    ///
    /// Data member Remove_transcript_id is mandatory;
    /// its type is defined as 'typedef bool TRemove_transcript_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRemove_transcript_id(void) const;
 
    /// Check if it is safe to call GetRemove_transcript_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRemove_transcript_id(void) const;
 
    /// Reset Remove_transcript_id data member.
    void ResetRemove_transcript_id(void);
 
    /// Get the Remove_transcript_id member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRemove_transcript_id GetRemove_transcript_id(void) const;
 
    /// Assign a value to Remove_transcript_id data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRemove_transcript_id(TRemove_transcript_id value);
 
    /// Assign a value to Remove_transcript_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRemove_transcript_id& SetRemove_transcript_id(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CConvert_from_CDS_options_Base(const CConvert_from_CDS_options_Base&);
    CConvert_from_CDS_options_Base& operator=(const CConvert_from_CDS_options_Base&);
 
    // data
    Uint4 m_set_State[1];
    bool m_Remove_mRNA;
    bool m_Remove_gene;
    bool m_Remove_transcript_id;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CConvert_from_CDS_options_Base::IsSetRemove_mRNA(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CConvert_from_CDS_options_Base::CanGetRemove_mRNA(void) const
{
    return IsSetRemove_mRNA();
}
 
inline
void CConvert_from_CDS_options_Base::ResetRemove_mRNA(void)
{
    m_Remove_mRNA = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_mRNA CConvert_from_CDS_options_Base::GetRemove_mRNA(void) const
{
    if (!CanGetRemove_mRNA()) {
        ThrowUnassigned(0);
    }
    return m_Remove_mRNA;
}
 
inline
void CConvert_from_CDS_options_Base::SetRemove_mRNA(CConvert_from_CDS_options_Base::TRemove_mRNA value)
{
    m_Remove_mRNA = value;
    m_set_State[0] |= 0x3;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_mRNA& CConvert_from_CDS_options_Base::SetRemove_mRNA(void)
{
#ifdef _DEBUG
    if (!IsSetRemove_mRNA()) {
        memset(&m_Remove_mRNA,UnassignedByte(),sizeof(m_Remove_mRNA));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Remove_mRNA;
}
 
inline
bool CConvert_from_CDS_options_Base::IsSetRemove_gene(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CConvert_from_CDS_options_Base::CanGetRemove_gene(void) const
{
    return IsSetRemove_gene();
}
 
inline
void CConvert_from_CDS_options_Base::ResetRemove_gene(void)
{
    m_Remove_gene = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_gene CConvert_from_CDS_options_Base::GetRemove_gene(void) const
{
    if (!CanGetRemove_gene()) {
        ThrowUnassigned(1);
    }
    return m_Remove_gene;
}
 
inline
void CConvert_from_CDS_options_Base::SetRemove_gene(CConvert_from_CDS_options_Base::TRemove_gene value)
{
    m_Remove_gene = value;
    m_set_State[0] |= 0xc;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_gene& CConvert_from_CDS_options_Base::SetRemove_gene(void)
{
#ifdef _DEBUG
    if (!IsSetRemove_gene()) {
        memset(&m_Remove_gene,UnassignedByte(),sizeof(m_Remove_gene));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Remove_gene;
}
 
inline
bool CConvert_from_CDS_options_Base::IsSetRemove_transcript_id(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CConvert_from_CDS_options_Base::CanGetRemove_transcript_id(void) const
{
    return IsSetRemove_transcript_id();
}
 
inline
void CConvert_from_CDS_options_Base::ResetRemove_transcript_id(void)
{
    m_Remove_transcript_id = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_transcript_id CConvert_from_CDS_options_Base::GetRemove_transcript_id(void) const
{
    if (!CanGetRemove_transcript_id()) {
        ThrowUnassigned(2);
    }
    return m_Remove_transcript_id;
}
 
inline
void CConvert_from_CDS_options_Base::SetRemove_transcript_id(CConvert_from_CDS_options_Base::TRemove_transcript_id value)
{
    m_Remove_transcript_id = value;
    m_set_State[0] |= 0x30;
}
 
inline
CConvert_from_CDS_options_Base::TRemove_transcript_id& CConvert_from_CDS_options_Base::SetRemove_transcript_id(void)
{
#ifdef _DEBUG
    if (!IsSetRemove_transcript_id()) {
        memset(&m_Remove_transcript_id,UnassignedByte(),sizeof(m_Remove_transcript_id));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Remove_transcript_id;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MACRO_CONVERT_FROM_CDS_OPTIONS_BASE_HPP