Remove_xrefs_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 Remove_xrefs_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_REMOVE_XREFS_ACTION_BASE_HPP
#define OBJECTS_MACRO_REMOVE_XREFS_ACTION_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::
 
 
// forward declarations
class CConstraint_choice_set;
class CXref_type;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Macro
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CRemove_xrefs_action_Base --
///
 
class CRemove_xrefs_action_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CRemove_xrefs_action_Base(void);
    // destructor
    virtual ~CRemove_xrefs_action_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CXref_type TXref_type;
    typedef CConstraint_choice_set TConstraint;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_xref_type,
        e_constraint
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Xref_type data member.
    ///
    /// Data member Xref_type is mandatory;
    /// its type is defined as 'typedef CXref_type TXref_type'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetXref_type(void) const;
 
    /// Check if it is safe to call GetXref_type method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetXref_type(void) const;
 
    /// Reset Xref_type data member.
    void ResetXref_type(void);
 
    /// Get the Xref_type member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TXref_type& GetXref_type(void) const;
 
    /// Assign a value to Xref_type data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetXref_type(TXref_type& value);
 
    /// Assign a value to Xref_type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TXref_type& SetXref_type(void);
 
    /// Check if a value has been assigned to Constraint data member.
    ///
    /// Data member Constraint is optional;
    /// its type is defined as 'typedef CConstraint_choice_set TConstraint'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetConstraint(void) const;
 
    /// Check if it is safe to call GetConstraint method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetConstraint(void) const;
 
    /// Reset Constraint data member.
    void ResetConstraint(void);
 
    /// Get the Constraint member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TConstraint& GetConstraint(void) const;
 
    /// Assign a value to Constraint data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetConstraint(TConstraint& value);
 
    /// Assign a value to Constraint data member.
    ///
    /// @return
    ///   Reference to the data value.
    TConstraint& SetConstraint(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CRemove_xrefs_action_Base(const CRemove_xrefs_action_Base&);
    CRemove_xrefs_action_Base& operator=(const CRemove_xrefs_action_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TXref_type > m_Xref_type;
    CRef< TConstraint > m_Constraint;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CRemove_xrefs_action_Base::IsSetXref_type(void) const
{
    return m_Xref_type.NotEmpty();
}
 
inline
bool CRemove_xrefs_action_Base::CanGetXref_type(void) const
{
    return true;
}
 
inline
const CRemove_xrefs_action_Base::TXref_type& CRemove_xrefs_action_Base::GetXref_type(void) const
{
    if ( !m_Xref_type ) {
        const_cast<CRemove_xrefs_action_Base*>(this)->ResetXref_type();
    }
    return (*m_Xref_type);
}
 
inline
CRemove_xrefs_action_Base::TXref_type& CRemove_xrefs_action_Base::SetXref_type(void)
{
    if ( !m_Xref_type ) {
        ResetXref_type();
    }
    return (*m_Xref_type);
}
 
inline
bool CRemove_xrefs_action_Base::IsSetConstraint(void) const
{
    return m_Constraint.NotEmpty();
}
 
inline
bool CRemove_xrefs_action_Base::CanGetConstraint(void) const
{
    return IsSetConstraint();
}
 
inline
const CRemove_xrefs_action_Base::TConstraint& CRemove_xrefs_action_Base::GetConstraint(void) const
{
    if (!CanGetConstraint()) {
        ThrowUnassigned(1);
    }
    return (*m_Constraint);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MACRO_REMOVE_XREFS_ACTION_BASE_HPP