Byte_graph_.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 Byte_graph_.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/seqres/seqres.asn">seqres.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqres/seqres.def">seqres.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQRES_BYTE_GRAPH_BASE_HPP
#define OBJECTS_SEQRES_BYTE_GRAPH_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <vector>
 
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_Seqres
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// integer from 0-255
///
/// CByte_graph_Base --
///
 
class NCBI_SEQRES_EXPORT CByte_graph_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CByte_graph_Base(void);
    // destructor
    virtual ~CByte_graph_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TMax;
    typedef int TMin;
    typedef int TAxis;
    typedef vector< char > TValues;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_max,
        e_min,
        e_axis,
        e_values
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Max data member.
    ///
    /// Data member Max is mandatory;
    /// its type is defined as 'typedef int 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
    ///   Copy of the member data.
    TMax GetMax(void) const;
 
    /// Assign a value to Max data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMax(TMax value);
 
    /// Assign a value to Max data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMax& SetMax(void);
 
    /// Check if a value has been assigned to Min data member.
    ///
    /// Data member Min is mandatory;
    /// its type is defined as 'typedef int 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
    ///   Copy of the member data.
    TMin GetMin(void) const;
 
    /// Assign a value to Min data member.
    ///
    /// @param value
    ///   Value to assign
    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 Axis data member.
    ///
    /// Data member Axis is mandatory;
    /// its type is defined as 'typedef int TAxis'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAxis(void) const;
 
    /// Check if it is safe to call GetAxis method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAxis(void) const;
 
    /// Reset Axis data member.
    void ResetAxis(void);
 
    /// Get the Axis member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAxis GetAxis(void) const;
 
    /// Assign a value to Axis data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAxis(TAxis value);
 
    /// Assign a value to Axis data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAxis& SetAxis(void);
 
    /// Check if a value has been assigned to Values data member.
    ///
    /// Data member Values is mandatory;
    /// its type is defined as 'typedef vector< char > TValues'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetValues(void) const;
 
    /// Check if it is safe to call GetValues method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetValues(void) const;
 
    /// Reset Values data member.
    void ResetValues(void);
 
    /// Get the Values member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TValues& GetValues(void) const;
 
    /// Assign a value to Values data member.
    ///
    /// @return
    ///   Reference to the data value.
    TValues& SetValues(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CByte_graph_Base(const CByte_graph_Base&);
    CByte_graph_Base& operator=(const CByte_graph_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Max;
    int m_Min;
    int m_Axis;
    vector< char > m_Values;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CByte_graph_Base::IsSetMax(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CByte_graph_Base::CanGetMax(void) const
{
    return IsSetMax();
}
 
inline
void CByte_graph_Base::ResetMax(void)
{
    m_Max = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CByte_graph_Base::TMax CByte_graph_Base::GetMax(void) const
{
    if (!CanGetMax()) {
        ThrowUnassigned(0);
    }
    return m_Max;
}
 
inline
void CByte_graph_Base::SetMax(CByte_graph_Base::TMax value)
{
    m_Max = value;
    m_set_State[0] |= 0x3;
}
 
inline
CByte_graph_Base::TMax& CByte_graph_Base::SetMax(void)
{
#ifdef _DEBUG
    if (!IsSetMax()) {
        memset(&m_Max,UnassignedByte(),sizeof(m_Max));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Max;
}
 
inline
bool CByte_graph_Base::IsSetMin(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CByte_graph_Base::CanGetMin(void) const
{
    return IsSetMin();
}
 
inline
void CByte_graph_Base::ResetMin(void)
{
    m_Min = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CByte_graph_Base::TMin CByte_graph_Base::GetMin(void) const
{
    if (!CanGetMin()) {
        ThrowUnassigned(1);
    }
    return m_Min;
}
 
inline
void CByte_graph_Base::SetMin(CByte_graph_Base::TMin value)
{
    m_Min = value;
    m_set_State[0] |= 0xc;
}
 
inline
CByte_graph_Base::TMin& CByte_graph_Base::SetMin(void)
{
#ifdef _DEBUG
    if (!IsSetMin()) {
        memset(&m_Min,UnassignedByte(),sizeof(m_Min));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Min;
}
 
inline
bool CByte_graph_Base::IsSetAxis(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CByte_graph_Base::CanGetAxis(void) const
{
    return IsSetAxis();
}
 
inline
void CByte_graph_Base::ResetAxis(void)
{
    m_Axis = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CByte_graph_Base::TAxis CByte_graph_Base::GetAxis(void) const
{
    if (!CanGetAxis()) {
        ThrowUnassigned(2);
    }
    return m_Axis;
}
 
inline
void CByte_graph_Base::SetAxis(CByte_graph_Base::TAxis value)
{
    m_Axis = value;
    m_set_State[0] |= 0x30;
}
 
inline
CByte_graph_Base::TAxis& CByte_graph_Base::SetAxis(void)
{
#ifdef _DEBUG
    if (!IsSetAxis()) {
        memset(&m_Axis,UnassignedByte(),sizeof(m_Axis));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Axis;
}
 
inline
bool CByte_graph_Base::IsSetValues(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CByte_graph_Base::CanGetValues(void) const
{
    return IsSetValues();
}
 
inline
const CByte_graph_Base::TValues& CByte_graph_Base::GetValues(void) const
{
    if (!CanGetValues()) {
        ThrowUnassigned(3);
    }
    return m_Values;
}
 
inline
CByte_graph_Base::TValues& CByte_graph_Base::SetValues(void)
{
    m_set_State[0] |= 0x40;
    return m_Values;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQRES_BYTE_GRAPH_BASE_HPP