Scaled_int_multi_data_.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 Scaled_int_multi_data_.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/seqtable/seqtable.asn">seqtable.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqtable/seqtable.def">seqtable.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQTABLE_SCALED_INT_MULTI_DATA_BASE_HPP
#define OBJECTS_SEQTABLE_SCALED_INT_MULTI_DATA_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 CSeqTable_multi_data;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_SeqTable
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CScaled_int_multi_data_Base --
///
 
class NCBI_SEQ_EXPORT CScaled_int_multi_data_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CScaled_int_multi_data_Base(void);
    // destructor
    virtual ~CScaled_int_multi_data_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TMul;
    typedef int TAdd;
    typedef CSeqTable_multi_data TData;
    typedef Int8 TMin;
    typedef Int8 TMax;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_mul,
        e_add,
        e_data,
        e_min,
        e_max
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// output data[i] = data[i]*mul+add
    /// Check if a value has been assigned to Mul data member.
    ///
    /// Data member Mul is mandatory;
    /// its type is defined as 'typedef int TMul'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMul(void) const;
 
    /// Check if it is safe to call GetMul method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMul(void) const;
 
    /// Reset Mul data member.
    void ResetMul(void);
 
    /// Get the Mul member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMul GetMul(void) const;
 
    /// Assign a value to Mul data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMul(TMul value);
 
    /// Assign a value to Mul data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMul& SetMul(void);
 
    /// Check if a value has been assigned to Add data member.
    ///
    /// Data member Add is mandatory;
    /// its type is defined as 'typedef int TAdd'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAdd(void) const;
 
    /// Check if it is safe to call GetAdd method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAdd(void) const;
 
    /// Reset Add data member.
    void ResetAdd(void);
 
    /// Get the Add member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAdd GetAdd(void) const;
 
    /// Assign a value to Add data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAdd(TAdd value);
 
    /// Assign a value to Add data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAdd& SetAdd(void);
 
    /// Check if a value has been assigned to Data data member.
    ///
    /// Data member Data is mandatory;
    /// its type is defined as 'typedef CSeqTable_multi_data TData'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetData(void) const;
 
    /// Check if it is safe to call GetData method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetData(void) const;
 
    /// Reset Data data member.
    void ResetData(void);
 
    /// Get the Data member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TData& GetData(void) const;
 
    /// Assign a value to Data data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetData(TData& value);
 
    /// Assign a value to Data data member.
    ///
    /// @return
    ///   Reference to the data value.
    TData& SetData(void);
 
    /// min/max scaled value
    /// should be set if scaled values may not fit in 32-bit signed integer
    /// Check if a value has been assigned to Min data member.
    ///
    /// Data member Min is optional;
    /// its type is defined as 'typedef Int8 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 Max data member.
    ///
    /// Data member Max is optional;
    /// its type is defined as 'typedef Int8 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);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CScaled_int_multi_data_Base(const CScaled_int_multi_data_Base&);
    CScaled_int_multi_data_Base& operator=(const CScaled_int_multi_data_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Mul;
    int m_Add;
    CRef< TData > m_Data;
    Int8 m_Min;
    Int8 m_Max;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CScaled_int_multi_data_Base::IsSetMul(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CScaled_int_multi_data_Base::CanGetMul(void) const
{
    return IsSetMul();
}
 
inline
void CScaled_int_multi_data_Base::ResetMul(void)
{
    m_Mul = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CScaled_int_multi_data_Base::TMul CScaled_int_multi_data_Base::GetMul(void) const
{
    if (!CanGetMul()) {
        ThrowUnassigned(0);
    }
    return m_Mul;
}
 
inline
void CScaled_int_multi_data_Base::SetMul(CScaled_int_multi_data_Base::TMul value)
{
    m_Mul = value;
    m_set_State[0] |= 0x3;
}
 
inline
CScaled_int_multi_data_Base::TMul& CScaled_int_multi_data_Base::SetMul(void)
{
#ifdef _DEBUG
    if (!IsSetMul()) {
        memset(&m_Mul,UnassignedByte(),sizeof(m_Mul));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Mul;
}
 
inline
bool CScaled_int_multi_data_Base::IsSetAdd(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CScaled_int_multi_data_Base::CanGetAdd(void) const
{
    return IsSetAdd();
}
 
inline
void CScaled_int_multi_data_Base::ResetAdd(void)
{
    m_Add = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CScaled_int_multi_data_Base::TAdd CScaled_int_multi_data_Base::GetAdd(void) const
{
    if (!CanGetAdd()) {
        ThrowUnassigned(1);
    }
    return m_Add;
}
 
inline
void CScaled_int_multi_data_Base::SetAdd(CScaled_int_multi_data_Base::TAdd value)
{
    m_Add = value;
    m_set_State[0] |= 0xc;
}
 
inline
CScaled_int_multi_data_Base::TAdd& CScaled_int_multi_data_Base::SetAdd(void)
{
#ifdef _DEBUG
    if (!IsSetAdd()) {
        memset(&m_Add,UnassignedByte(),sizeof(m_Add));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Add;
}
 
inline
bool CScaled_int_multi_data_Base::IsSetData(void) const
{
    return m_Data.NotEmpty();
}
 
inline
bool CScaled_int_multi_data_Base::CanGetData(void) const
{
    return true;
}
 
inline
const CScaled_int_multi_data_Base::TData& CScaled_int_multi_data_Base::GetData(void) const
{
    if ( !m_Data ) {
        const_cast<CScaled_int_multi_data_Base*>(this)->ResetData();
    }
    return (*m_Data);
}
 
inline
CScaled_int_multi_data_Base::TData& CScaled_int_multi_data_Base::SetData(void)
{
    if ( !m_Data ) {
        ResetData();
    }
    return (*m_Data);
}
 
inline
bool CScaled_int_multi_data_Base::IsSetMin(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CScaled_int_multi_data_Base::CanGetMin(void) const
{
    return IsSetMin();
}
 
inline
void CScaled_int_multi_data_Base::ResetMin(void)
{
    m_Min = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CScaled_int_multi_data_Base::TMin CScaled_int_multi_data_Base::GetMin(void) const
{
    if (!CanGetMin()) {
        ThrowUnassigned(3);
    }
    return m_Min;
}
 
inline
void CScaled_int_multi_data_Base::SetMin(CScaled_int_multi_data_Base::TMin value)
{
    m_Min = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CScaled_int_multi_data_Base::TMin& CScaled_int_multi_data_Base::SetMin(void)
{
#ifdef _DEBUG
    if (!IsSetMin()) {
        memset(&m_Min,UnassignedByte(),sizeof(m_Min));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Min;
}
 
inline
bool CScaled_int_multi_data_Base::IsSetMax(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CScaled_int_multi_data_Base::CanGetMax(void) const
{
    return IsSetMax();
}
 
inline
void CScaled_int_multi_data_Base::ResetMax(void)
{
    m_Max = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CScaled_int_multi_data_Base::TMax CScaled_int_multi_data_Base::GetMax(void) const
{
    if (!CanGetMax()) {
        ThrowUnassigned(4);
    }
    return m_Max;
}
 
inline
void CScaled_int_multi_data_Base::SetMax(CScaled_int_multi_data_Base::TMax value)
{
    m_Max = value;
    m_set_State[0] |= 0x300;
}
 
inline
CScaled_int_multi_data_Base::TMax& CScaled_int_multi_data_Base::SetMax(void)
{
#ifdef _DEBUG
    if (!IsSetMax()) {
        memset(&m_Max,UnassignedByte(),sizeof(m_Max));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Max;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQTABLE_SCALED_INT_MULTI_DATA_BASE_HPP