Mim_text_.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 Mim_text_.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/mim/mim.asn">mim.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mim/mim.def">mim.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MIM_MIM_TEXT_BASE_HPP
#define OBJECTS_MIM_MIM_TEXT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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 CMim_link;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Mim
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CMim_text_Base --
///
 
class NCBI_MIM_EXPORT CMim_text_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMim_text_Base(void);
    // destructor
    virtual ~CMim_text_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TLabel;
    typedef string TText;
    typedef CMim_link TNeighbors;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_label,
        e_text,
        e_neighbors
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Label data member.
    ///
    /// Data member Label is mandatory;
    /// its type is defined as 'typedef string TLabel'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLabel(void) const;
 
    /// Check if it is safe to call GetLabel method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLabel(void) const;
 
    /// Reset Label data member.
    void ResetLabel(void);
 
    /// Get the Label member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLabel& GetLabel(void) const;
 
    /// Assign a value to Label data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLabel(const TLabel& value);
    void SetLabel(TLabel&& value);
 
    /// Assign a value to Label data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLabel& SetLabel(void);
 
    /// Check if a value has been assigned to Text data member.
    ///
    /// Data member Text is mandatory;
    /// its type is defined as 'typedef string TText'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetText(void) const;
 
    /// Check if it is safe to call GetText method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetText(void) const;
 
    /// Reset Text data member.
    void ResetText(void);
 
    /// Get the Text member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TText& GetText(void) const;
 
    /// Assign a value to Text data member.
    ///
    /// @param value
    ///   Value to assign
    void SetText(const TText& value);
    void SetText(TText&& value);
 
    /// Assign a value to Text data member.
    ///
    /// @return
    ///   Reference to the data value.
    TText& SetText(void);
 
    /// Check if a value has been assigned to Neighbors data member.
    ///
    /// Data member Neighbors is optional;
    /// its type is defined as 'typedef CMim_link TNeighbors'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNeighbors(void) const;
 
    /// Check if it is safe to call GetNeighbors method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNeighbors(void) const;
 
    /// Reset Neighbors data member.
    void ResetNeighbors(void);
 
    /// Get the Neighbors member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TNeighbors& GetNeighbors(void) const;
 
    /// Assign a value to Neighbors data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetNeighbors(TNeighbors& value);
 
    /// Assign a value to Neighbors data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNeighbors& SetNeighbors(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMim_text_Base(const CMim_text_Base&);
    CMim_text_Base& operator=(const CMim_text_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Label;
    string m_Text;
    CRef< TNeighbors > m_Neighbors;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMim_text_Base::IsSetLabel(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CMim_text_Base::CanGetLabel(void) const
{
    return IsSetLabel();
}
 
inline
const CMim_text_Base::TLabel& CMim_text_Base::GetLabel(void) const
{
    if (!CanGetLabel()) {
        ThrowUnassigned(0);
    }
    return m_Label;
}
 
inline
void CMim_text_Base::SetLabel(const CMim_text_Base::TLabel& value)
{
    m_Label = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CMim_text_Base::SetLabel(CMim_text_Base::TLabel&& value)
{
    m_Label = std::forward<CMim_text_Base::TLabel>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CMim_text_Base::TLabel& CMim_text_Base::SetLabel(void)
{
#ifdef _DEBUG
    if (!IsSetLabel()) {
        m_Label = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Label;
}
 
inline
bool CMim_text_Base::IsSetText(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMim_text_Base::CanGetText(void) const
{
    return IsSetText();
}
 
inline
const CMim_text_Base::TText& CMim_text_Base::GetText(void) const
{
    if (!CanGetText()) {
        ThrowUnassigned(1);
    }
    return m_Text;
}
 
inline
void CMim_text_Base::SetText(const CMim_text_Base::TText& value)
{
    m_Text = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CMim_text_Base::SetText(CMim_text_Base::TText&& value)
{
    m_Text = std::forward<CMim_text_Base::TText>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CMim_text_Base::TText& CMim_text_Base::SetText(void)
{
#ifdef _DEBUG
    if (!IsSetText()) {
        m_Text = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Text;
}
 
inline
bool CMim_text_Base::IsSetNeighbors(void) const
{
    return m_Neighbors.NotEmpty();
}
 
inline
bool CMim_text_Base::CanGetNeighbors(void) const
{
    return IsSetNeighbors();
}
 
inline
const CMim_text_Base::TNeighbors& CMim_text_Base::GetNeighbors(void) const
{
    if (!CanGetNeighbors()) {
        ThrowUnassigned(2);
    }
    return (*m_Neighbors);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MIM_MIM_TEXT_BASE_HPP