RangeValue_.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 RangeValue_.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_RANGEVALUE_BASE_HPP
#define GUI_OBJECTS_RANGEVALUE_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_SeqGraphical
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CRangeValue_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CRangeValue_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CRangeValue_Base(void);
    // destructor
    virtual ~CRangeValue_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TMin;
    typedef string TMax;
    typedef bool TAutoscale;
    typedef bool TInverse;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_min,
        e_max,
        e_autoscale,
        e_inverse
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Min data member.
    ///
    /// Data member Min is mandatory;
    /// its type is defined as 'typedef string TMin'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMin(void) const;
 
    /// Check if it is safe to call GetMin method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMin(void) const;
 
    /// Reset Min data member.
    void ResetMin(void);
 
    /// Get the Min member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMin& GetMin(void) const;
 
    /// Assign a value to Min data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMin(const TMin& value);
    void SetMin(TMin&& value);
 
    /// Assign a value to Min data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMin& SetMin(void);
 
    /// Check if a value has been assigned to Max data member.
    ///
    /// Data member Max is mandatory;
    /// its type is defined as 'typedef string TMax'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMax(void) const;
 
    /// Check if it is safe to call GetMax method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMax(void) const;
 
    /// Reset Max data member.
    void ResetMax(void);
 
    /// Get the Max member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMax& GetMax(void) const;
 
    /// Assign a value to Max data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMax(const TMax& value);
    void SetMax(TMax&& value);
 
    /// Assign a value to Max data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMax& SetMax(void);
 
    /// if TRUE range min/max are ignored 
    /// Check if a value has been assigned to Autoscale data member.
    ///
    /// Data member Autoscale is optional with default true;
    /// its type is defined as 'typedef bool TAutoscale'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAutoscale(void) const;
 
    /// Check if it is safe to call GetAutoscale method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAutoscale(void) const;
 
    /// Reset Autoscale data member.
    void ResetAutoscale(void);
 
    /// Assign default value to Autoscale data member.
    void SetDefaultAutoscale(void);
 
    /// Get the Autoscale member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAutoscale GetAutoscale(void) const;
 
    /// Assign a value to Autoscale data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAutoscale(TAutoscale value);
 
    /// Assign a value to Autoscale data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAutoscale& SetAutoscale(void);
 
    /// TRUE if max value should go first in UI
    /// Check if a value has been assigned to Inverse data member.
    ///
    /// Data member Inverse is optional with default false;
    /// its type is defined as 'typedef bool TInverse'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetInverse(void) const;
 
    /// Check if it is safe to call GetInverse method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetInverse(void) const;
 
    /// Reset Inverse data member.
    void ResetInverse(void);
 
    /// Assign default value to Inverse data member.
    void SetDefaultInverse(void);
 
    /// Get the Inverse member data.
    ///
    /// @return
    ///   Copy of the member data.
    TInverse GetInverse(void) const;
 
    /// Assign a value to Inverse data member.
    ///
    /// @param value
    ///   Value to assign
    void SetInverse(TInverse value);
 
    /// Assign a value to Inverse data member.
    ///
    /// @return
    ///   Reference to the data value.
    TInverse& SetInverse(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CRangeValue_Base(const CRangeValue_Base&);
    CRangeValue_Base& operator=(const CRangeValue_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Min;
    string m_Max;
    bool m_Autoscale;
    bool m_Inverse;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CRangeValue_Base::IsSetMin(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CRangeValue_Base::CanGetMin(void) const
{
    return IsSetMin();
}
 
inline
const CRangeValue_Base::TMin& CRangeValue_Base::GetMin(void) const
{
    if (!CanGetMin()) {
        ThrowUnassigned(0);
    }
    return m_Min;
}
 
inline
void CRangeValue_Base::SetMin(const CRangeValue_Base::TMin& value)
{
    m_Min = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CRangeValue_Base::SetMin(CRangeValue_Base::TMin&& value)
{
    m_Min = std::forward<CRangeValue_Base::TMin>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CRangeValue_Base::TMin& CRangeValue_Base::SetMin(void)
{
#ifdef _DEBUG
    if (!IsSetMin()) {
        m_Min = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Min;
}
 
inline
bool CRangeValue_Base::IsSetMax(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CRangeValue_Base::CanGetMax(void) const
{
    return IsSetMax();
}
 
inline
const CRangeValue_Base::TMax& CRangeValue_Base::GetMax(void) const
{
    if (!CanGetMax()) {
        ThrowUnassigned(1);
    }
    return m_Max;
}
 
inline
void CRangeValue_Base::SetMax(const CRangeValue_Base::TMax& value)
{
    m_Max = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CRangeValue_Base::SetMax(CRangeValue_Base::TMax&& value)
{
    m_Max = std::forward<CRangeValue_Base::TMax>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CRangeValue_Base::TMax& CRangeValue_Base::SetMax(void)
{
#ifdef _DEBUG
    if (!IsSetMax()) {
        m_Max = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Max;
}
 
inline
bool CRangeValue_Base::IsSetAutoscale(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CRangeValue_Base::CanGetAutoscale(void) const
{
    return true;
}
 
inline
void CRangeValue_Base::ResetAutoscale(void)
{
    m_Autoscale = true;
    m_set_State[0] &= ~0x30;
}
 
inline
void CRangeValue_Base::SetDefaultAutoscale(void)
{
    ResetAutoscale();
}
 
inline
CRangeValue_Base::TAutoscale CRangeValue_Base::GetAutoscale(void) const
{
    return m_Autoscale;
}
 
inline
void CRangeValue_Base::SetAutoscale(CRangeValue_Base::TAutoscale value)
{
    m_Autoscale = value;
    m_set_State[0] |= 0x30;
}
 
inline
CRangeValue_Base::TAutoscale& CRangeValue_Base::SetAutoscale(void)
{
#ifdef _DEBUG
    if (!IsSetAutoscale()) {
        memset(&m_Autoscale,UnassignedByte(),sizeof(m_Autoscale));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Autoscale;
}
 
inline
bool CRangeValue_Base::IsSetInverse(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CRangeValue_Base::CanGetInverse(void) const
{
    return true;
}
 
inline
void CRangeValue_Base::ResetInverse(void)
{
    m_Inverse = false;
    m_set_State[0] &= ~0xc0;
}
 
inline
void CRangeValue_Base::SetDefaultInverse(void)
{
    ResetInverse();
}
 
inline
CRangeValue_Base::TInverse CRangeValue_Base::GetInverse(void) const
{
    return m_Inverse;
}
 
inline
void CRangeValue_Base::SetInverse(CRangeValue_Base::TInverse value)
{
    m_Inverse = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CRangeValue_Base::TInverse& CRangeValue_Base::SetInverse(void)
{
#ifdef _DEBUG
    if (!IsSetInverse()) {
        memset(&m_Inverse,UnassignedByte(),sizeof(m_Inverse));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Inverse;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_RANGEVALUE_BASE_HPP