Cache_blob_.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 Cache_blob_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/data_loaders/asn_cache/cache_blob.asn">cache_blob.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/data_loaders/asn_cache/cache_blob.def">cache_blob.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJTOOLS_DATA_LOADERS_ASN_CACHE_CACHE_BLOB_BASE_HPP
#define OBJTOOLS_DATA_LOADERS_ASN_CACHE_CACHE_BLOB_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_ASN_Cache
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CCache_blob_Base --
///
 
class CCache_blob_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCache_blob_Base(void);
    // destructor
    virtual ~CCache_blob_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TMagic;
    typedef int TTimestamp;
    typedef vector< char > TBlob;
    typedef vector< char > TMd5_digest;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_magic,
        e_timestamp,
        e_blob,
        e_md5_digest
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Magic data member.
    ///
    /// Data member Magic is mandatory;
    /// its type is defined as 'typedef int TMagic'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMagic(void) const;
 
    /// Check if it is safe to call GetMagic method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMagic(void) const;
 
    /// Reset Magic data member.
    void ResetMagic(void);
 
    /// Get the Magic member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMagic GetMagic(void) const;
 
    /// Assign a value to Magic data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMagic(TMagic value);
 
    /// Assign a value to Magic data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMagic& SetMagic(void);
 
    /// Check if a value has been assigned to Timestamp data member.
    ///
    /// Data member Timestamp is mandatory;
    /// its type is defined as 'typedef int TTimestamp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTimestamp(void) const;
 
    /// Check if it is safe to call GetTimestamp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTimestamp(void) const;
 
    /// Reset Timestamp data member.
    void ResetTimestamp(void);
 
    /// Get the Timestamp member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTimestamp GetTimestamp(void) const;
 
    /// Assign a value to Timestamp data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTimestamp(TTimestamp value);
 
    /// Assign a value to Timestamp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTimestamp& SetTimestamp(void);
 
    /// Check if a value has been assigned to Blob data member.
    ///
    /// Data member Blob is mandatory;
    /// its type is defined as 'typedef vector< char > TBlob'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBlob(void) const;
 
    /// Check if it is safe to call GetBlob method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBlob(void) const;
 
    /// Reset Blob data member.
    void ResetBlob(void);
 
    /// Get the Blob member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBlob& GetBlob(void) const;
 
    /// Assign a value to Blob data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBlob& SetBlob(void);
 
    /// Check if a value has been assigned to Md5_digest data member.
    ///
    /// Data member Md5_digest is mandatory;
    /// its type is defined as 'typedef vector< char > TMd5_digest'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMd5_digest(void) const;
 
    /// Check if it is safe to call GetMd5_digest method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMd5_digest(void) const;
 
    /// Reset Md5_digest data member.
    void ResetMd5_digest(void);
 
    /// Get the Md5_digest member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMd5_digest& GetMd5_digest(void) const;
 
    /// Assign a value to Md5_digest data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMd5_digest& SetMd5_digest(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCache_blob_Base(const CCache_blob_Base&);
    CCache_blob_Base& operator=(const CCache_blob_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Magic;
    int m_Timestamp;
    vector< char > m_Blob;
    vector< char > m_Md5_digest;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCache_blob_Base::IsSetMagic(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CCache_blob_Base::CanGetMagic(void) const
{
    return IsSetMagic();
}
 
inline
void CCache_blob_Base::ResetMagic(void)
{
    m_Magic = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CCache_blob_Base::TMagic CCache_blob_Base::GetMagic(void) const
{
    if (!CanGetMagic()) {
        ThrowUnassigned(0);
    }
    return m_Magic;
}
 
inline
void CCache_blob_Base::SetMagic(CCache_blob_Base::TMagic value)
{
    m_Magic = value;
    m_set_State[0] |= 0x3;
}
 
inline
CCache_blob_Base::TMagic& CCache_blob_Base::SetMagic(void)
{
#ifdef _DEBUG
    if (!IsSetMagic()) {
        memset(&m_Magic,UnassignedByte(),sizeof(m_Magic));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Magic;
}
 
inline
bool CCache_blob_Base::IsSetTimestamp(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CCache_blob_Base::CanGetTimestamp(void) const
{
    return IsSetTimestamp();
}
 
inline
void CCache_blob_Base::ResetTimestamp(void)
{
    m_Timestamp = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CCache_blob_Base::TTimestamp CCache_blob_Base::GetTimestamp(void) const
{
    if (!CanGetTimestamp()) {
        ThrowUnassigned(1);
    }
    return m_Timestamp;
}
 
inline
void CCache_blob_Base::SetTimestamp(CCache_blob_Base::TTimestamp value)
{
    m_Timestamp = value;
    m_set_State[0] |= 0xc;
}
 
inline
CCache_blob_Base::TTimestamp& CCache_blob_Base::SetTimestamp(void)
{
#ifdef _DEBUG
    if (!IsSetTimestamp()) {
        memset(&m_Timestamp,UnassignedByte(),sizeof(m_Timestamp));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Timestamp;
}
 
inline
bool CCache_blob_Base::IsSetBlob(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CCache_blob_Base::CanGetBlob(void) const
{
    return IsSetBlob();
}
 
inline
const CCache_blob_Base::TBlob& CCache_blob_Base::GetBlob(void) const
{
    if (!CanGetBlob()) {
        ThrowUnassigned(2);
    }
    return m_Blob;
}
 
inline
CCache_blob_Base::TBlob& CCache_blob_Base::SetBlob(void)
{
    m_set_State[0] |= 0x10;
    return m_Blob;
}
 
inline
bool CCache_blob_Base::IsSetMd5_digest(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CCache_blob_Base::CanGetMd5_digest(void) const
{
    return IsSetMd5_digest();
}
 
inline
const CCache_blob_Base::TMd5_digest& CCache_blob_Base::GetMd5_digest(void) const
{
    if (!CanGetMd5_digest()) {
        ThrowUnassigned(3);
    }
    return m_Md5_digest;
}
 
inline
CCache_blob_Base::TMd5_digest& CCache_blob_Base::SetMd5_digest(void)
{
    m_set_State[0] |= 0x40;
    return m_Md5_digest;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJTOOLS_DATA_LOADERS_ASN_CACHE_CACHE_BLOB_BASE_HPP