PluginValueRangeConstraint_.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 PluginValueRangeConstraint_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.asn">gui_objects.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef GUI_OBJECTS_PLUGINVALUERANGECONSTRAINT_BASE_HPP
#define GUI_OBJECTS_PLUGINVALUERANGECONSTRAINT_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// 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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CPluginValueRangeConstraint_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginValueRangeConstraint_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginValueRangeConstraint_Base(void);
    // destructor
    virtual ~CPluginValueRangeConstraint_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TLower;
    typedef string TUpper;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_lower,
        e_upper
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Lower data member.
    ///
    /// Data member Lower is mandatory;
    /// its type is defined as 'typedef string TLower'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLower(void) const;
 
    /// Check if it is safe to call GetLower method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLower(void) const;
 
    /// Reset Lower data member.
    void ResetLower(void);
 
    /// Get the Lower member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLower& GetLower(void) const;
 
    /// Assign a value to Lower data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLower(const TLower& value);
    void SetLower(TLower&& value);
 
    /// Assign a value to Lower data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLower& SetLower(void);
 
    /// Check if a value has been assigned to Upper data member.
    ///
    /// Data member Upper is mandatory;
    /// its type is defined as 'typedef string TUpper'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUpper(void) const;
 
    /// Check if it is safe to call GetUpper method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUpper(void) const;
 
    /// Reset Upper data member.
    void ResetUpper(void);
 
    /// Get the Upper member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUpper& GetUpper(void) const;
 
    /// Assign a value to Upper data member.
    ///
    /// @param value
    ///   Value to assign
    void SetUpper(const TUpper& value);
    void SetUpper(TUpper&& value);
 
    /// Assign a value to Upper data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUpper& SetUpper(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginValueRangeConstraint_Base(const CPluginValueRangeConstraint_Base&);
    CPluginValueRangeConstraint_Base& operator=(const CPluginValueRangeConstraint_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Lower;
    string m_Upper;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginValueRangeConstraint_Base::IsSetLower(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginValueRangeConstraint_Base::CanGetLower(void) const
{
    return IsSetLower();
}
 
inline
const CPluginValueRangeConstraint_Base::TLower& CPluginValueRangeConstraint_Base::GetLower(void) const
{
    if (!CanGetLower()) {
        ThrowUnassigned(0);
    }
    return m_Lower;
}
 
inline
void CPluginValueRangeConstraint_Base::SetLower(const CPluginValueRangeConstraint_Base::TLower& value)
{
    m_Lower = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPluginValueRangeConstraint_Base::SetLower(CPluginValueRangeConstraint_Base::TLower&& value)
{
    m_Lower = std::forward<CPluginValueRangeConstraint_Base::TLower>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPluginValueRangeConstraint_Base::TLower& CPluginValueRangeConstraint_Base::SetLower(void)
{
#ifdef _DEBUG
    if (!IsSetLower()) {
        m_Lower = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Lower;
}
 
inline
bool CPluginValueRangeConstraint_Base::IsSetUpper(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginValueRangeConstraint_Base::CanGetUpper(void) const
{
    return IsSetUpper();
}
 
inline
const CPluginValueRangeConstraint_Base::TUpper& CPluginValueRangeConstraint_Base::GetUpper(void) const
{
    if (!CanGetUpper()) {
        ThrowUnassigned(1);
    }
    return m_Upper;
}
 
inline
void CPluginValueRangeConstraint_Base::SetUpper(const CPluginValueRangeConstraint_Base::TUpper& value)
{
    m_Upper = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPluginValueRangeConstraint_Base::SetUpper(CPluginValueRangeConstraint_Base::TUpper&& value)
{
    m_Upper = std::forward<CPluginValueRangeConstraint_Base::TUpper>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPluginValueRangeConstraint_Base::TUpper& CPluginValueRangeConstraint_Base::SetUpper(void)
{
#ifdef _DEBUG
    if (!IsSetUpper()) {
        m_Upper = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Upper;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINVALUERANGECONSTRAINT_BASE_HPP