Autodef_action_.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 Autodef_action_.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_AUTODEF_ACTION_BASE_HPP
#define OBJECTS_MACRO_AUTODEF_ACTION_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <objects/macro/Autod_misc_feat_parse_rule.hpp>
#include <objects/macro/Autodef_list_type.hpp>
#include <objects/macro/Source_qual.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
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CAutodef_action_Base --
///
 
class CAutodef_action_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CAutodef_action_Base(void);
    // destructor
    virtual ~CAutodef_action_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef list< ESource_qual > TModifiers;
    typedef EAutodef_list_type TClause_list_type;
    typedef EAutodef_misc_feat_parse_rule TMisc_feat_parse_rule;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_modifiers,
        e_clause_list_type,
        e_misc_feat_parse_rule
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Modifiers data member.
    ///
    /// Data member Modifiers is optional;
    /// its type is defined as 'typedef list< ESource_qual > TModifiers'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetModifiers(void) const;
 
    /// Check if it is safe to call GetModifiers method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetModifiers(void) const;
 
    /// Reset Modifiers data member.
    void ResetModifiers(void);
 
    /// Get the Modifiers member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TModifiers& GetModifiers(void) const;
 
    /// Assign a value to Modifiers data member.
    ///
    /// @return
    ///   Reference to the data value.
    TModifiers& SetModifiers(void);
 
    /// Check if a value has been assigned to Clause_list_type data member.
    ///
    /// Data member Clause_list_type is mandatory;
    /// its type is defined as 'typedef EAutodef_list_type TClause_list_type'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetClause_list_type(void) const;
 
    /// Check if it is safe to call GetClause_list_type method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetClause_list_type(void) const;
 
    /// Reset Clause_list_type data member.
    void ResetClause_list_type(void);
 
    /// Get the Clause_list_type member data.
    ///
    /// @return
    ///   Copy of the member data.
    TClause_list_type GetClause_list_type(void) const;
 
    /// Assign a value to Clause_list_type data member.
    ///
    /// @param value
    ///   Value to assign
    void SetClause_list_type(TClause_list_type value);
 
    /// Assign a value to Clause_list_type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TClause_list_type& SetClause_list_type(void);
 
    /// Check if a value has been assigned to Misc_feat_parse_rule data member.
    ///
    /// Data member Misc_feat_parse_rule is optional with default eAutodef_misc_feat_parse_rule_look_for_noncoding_products;
    /// its type is defined as 'typedef EAutodef_misc_feat_parse_rule TMisc_feat_parse_rule'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMisc_feat_parse_rule(void) const;
 
    /// Check if it is safe to call GetMisc_feat_parse_rule method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMisc_feat_parse_rule(void) const;
 
    /// Reset Misc_feat_parse_rule data member.
    void ResetMisc_feat_parse_rule(void);
 
    /// Assign default value to Misc_feat_parse_rule data member.
    void SetDefaultMisc_feat_parse_rule(void);
 
    /// Get the Misc_feat_parse_rule member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMisc_feat_parse_rule GetMisc_feat_parse_rule(void) const;
 
    /// Assign a value to Misc_feat_parse_rule data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMisc_feat_parse_rule(TMisc_feat_parse_rule value);
 
    /// Assign a value to Misc_feat_parse_rule data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMisc_feat_parse_rule& SetMisc_feat_parse_rule(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CAutodef_action_Base(const CAutodef_action_Base&);
    CAutodef_action_Base& operator=(const CAutodef_action_Base&);
 
    // data
    Uint4 m_set_State[1];
    list< ESource_qual > m_Modifiers;
    EAutodef_list_type m_Clause_list_type;
    EAutodef_misc_feat_parse_rule m_Misc_feat_parse_rule;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CAutodef_action_Base::IsSetModifiers(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CAutodef_action_Base::CanGetModifiers(void) const
{
    return true;
}
 
inline
const CAutodef_action_Base::TModifiers& CAutodef_action_Base::GetModifiers(void) const
{
    return m_Modifiers;
}
 
inline
CAutodef_action_Base::TModifiers& CAutodef_action_Base::SetModifiers(void)
{
    m_set_State[0] |= 0x1;
    return m_Modifiers;
}
 
inline
bool CAutodef_action_Base::IsSetClause_list_type(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAutodef_action_Base::CanGetClause_list_type(void) const
{
    return IsSetClause_list_type();
}
 
inline
void CAutodef_action_Base::ResetClause_list_type(void)
{
    m_Clause_list_type = (ncbi::objects::EAutodef_list_type)(0);
    m_set_State[0] &= ~0xc;
}
 
inline
CAutodef_action_Base::TClause_list_type CAutodef_action_Base::GetClause_list_type(void) const
{
    if (!CanGetClause_list_type()) {
        ThrowUnassigned(1);
    }
    return m_Clause_list_type;
}
 
inline
void CAutodef_action_Base::SetClause_list_type(CAutodef_action_Base::TClause_list_type value)
{
    m_Clause_list_type = value;
    m_set_State[0] |= 0xc;
}
 
inline
CAutodef_action_Base::TClause_list_type& CAutodef_action_Base::SetClause_list_type(void)
{
#ifdef _DEBUG
    if (!IsSetClause_list_type()) {
        memset(&m_Clause_list_type,UnassignedByte(),sizeof(m_Clause_list_type));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Clause_list_type;
}
 
inline
bool CAutodef_action_Base::IsSetMisc_feat_parse_rule(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CAutodef_action_Base::CanGetMisc_feat_parse_rule(void) const
{
    return true;
}
 
inline
void CAutodef_action_Base::ResetMisc_feat_parse_rule(void)
{
    m_Misc_feat_parse_rule = eAutodef_misc_feat_parse_rule_look_for_noncoding_products;
    m_set_State[0] &= ~0x30;
}
 
inline
void CAutodef_action_Base::SetDefaultMisc_feat_parse_rule(void)
{
    ResetMisc_feat_parse_rule();
}
 
inline
CAutodef_action_Base::TMisc_feat_parse_rule CAutodef_action_Base::GetMisc_feat_parse_rule(void) const
{
    return m_Misc_feat_parse_rule;
}
 
inline
void CAutodef_action_Base::SetMisc_feat_parse_rule(CAutodef_action_Base::TMisc_feat_parse_rule value)
{
    m_Misc_feat_parse_rule = value;
    m_set_State[0] |= 0x30;
}
 
inline
CAutodef_action_Base::TMisc_feat_parse_rule& CAutodef_action_Base::SetMisc_feat_parse_rule(void)
{
#ifdef _DEBUG
    if (!IsSetMisc_feat_parse_rule()) {
        memset(&m_Misc_feat_parse_rule,UnassignedByte(),sizeof(m_Misc_feat_parse_rule));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Misc_feat_parse_rule;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MACRO_AUTODEF_ACTION_BASE_HPP