ID2_Request_ReGet_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 ID2_Request_ReGet_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/objects/id2/id2.asn">id2.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/id2/id2.def">id2.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_ID2_ID2_REQUEST_REGET_BLOB_BASE_HPP
#define OBJECTS_ID2_ID2_REQUEST_REGET_BLOB_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 CID2_Blob_Id;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_ID2Access
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// This is similar to FTP reget command.
/// It may be unsupported by server.
/// It's defined only for plain blobs (returned in ID2-Reply-Get-Blob)
/// as all split data comes in small chunks, so reget doesn't make sense.
///
/// CID2_Request_ReGet_Blob_Base --
///
 
class NCBI_ID2_EXPORT CID2_Request_ReGet_Blob_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CID2_Request_ReGet_Blob_Base(void);
    // destructor
    virtual ~CID2_Request_ReGet_Blob_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CID2_Blob_Id TBlob_id;
    typedef int TSplit_version;
    typedef int TOffset;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_blob_id,
        e_split_version,
        e_offset
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Blob_id data member.
    ///
    /// Data member Blob_id is mandatory;
    /// its type is defined as 'typedef CID2_Blob_Id TBlob_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBlob_id(void) const;
 
    /// Check if it is safe to call GetBlob_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBlob_id(void) const;
 
    /// Reset Blob_id data member.
    void ResetBlob_id(void);
 
    /// Get the Blob_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBlob_id& GetBlob_id(void) const;
 
    /// Assign a value to Blob_id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetBlob_id(TBlob_id& value);
 
    /// Assign a value to Blob_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBlob_id& SetBlob_id(void);
 
    /// blob split version to resend
    /// Check if a value has been assigned to Split_version data member.
    ///
    /// Data member Split_version is mandatory;
    /// its type is defined as 'typedef int TSplit_version'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSplit_version(void) const;
 
    /// Check if it is safe to call GetSplit_version method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSplit_version(void) const;
 
    /// Reset Split_version data member.
    void ResetSplit_version(void);
 
    /// Get the Split_version member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSplit_version GetSplit_version(void) const;
 
    /// Assign a value to Split_version data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSplit_version(TSplit_version value);
 
    /// Assign a value to Split_version data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSplit_version& SetSplit_version(void);
 
    /// start offset of data to get
    /// Check if a value has been assigned to Offset data member.
    ///
    /// Data member Offset is mandatory;
    /// its type is defined as 'typedef int TOffset'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOffset(void) const;
 
    /// Check if it is safe to call GetOffset method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOffset(void) const;
 
    /// Reset Offset data member.
    void ResetOffset(void);
 
    /// Get the Offset member data.
    ///
    /// @return
    ///   Copy of the member data.
    TOffset GetOffset(void) const;
 
    /// Assign a value to Offset data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOffset(TOffset value);
 
    /// Assign a value to Offset data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOffset& SetOffset(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CID2_Request_ReGet_Blob_Base(const CID2_Request_ReGet_Blob_Base&);
    CID2_Request_ReGet_Blob_Base& operator=(const CID2_Request_ReGet_Blob_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TBlob_id > m_Blob_id;
    int m_Split_version;
    int m_Offset;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CID2_Request_ReGet_Blob_Base::IsSetBlob_id(void) const
{
    return m_Blob_id.NotEmpty();
}
 
inline
bool CID2_Request_ReGet_Blob_Base::CanGetBlob_id(void) const
{
    return true;
}
 
inline
const CID2_Request_ReGet_Blob_Base::TBlob_id& CID2_Request_ReGet_Blob_Base::GetBlob_id(void) const
{
    if ( !m_Blob_id ) {
        const_cast<CID2_Request_ReGet_Blob_Base*>(this)->ResetBlob_id();
    }
    return (*m_Blob_id);
}
 
inline
CID2_Request_ReGet_Blob_Base::TBlob_id& CID2_Request_ReGet_Blob_Base::SetBlob_id(void)
{
    if ( !m_Blob_id ) {
        ResetBlob_id();
    }
    return (*m_Blob_id);
}
 
inline
bool CID2_Request_ReGet_Blob_Base::IsSetSplit_version(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CID2_Request_ReGet_Blob_Base::CanGetSplit_version(void) const
{
    return IsSetSplit_version();
}
 
inline
void CID2_Request_ReGet_Blob_Base::ResetSplit_version(void)
{
    m_Split_version = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CID2_Request_ReGet_Blob_Base::TSplit_version CID2_Request_ReGet_Blob_Base::GetSplit_version(void) const
{
    if (!CanGetSplit_version()) {
        ThrowUnassigned(1);
    }
    return m_Split_version;
}
 
inline
void CID2_Request_ReGet_Blob_Base::SetSplit_version(CID2_Request_ReGet_Blob_Base::TSplit_version value)
{
    m_Split_version = value;
    m_set_State[0] |= 0xc;
}
 
inline
CID2_Request_ReGet_Blob_Base::TSplit_version& CID2_Request_ReGet_Blob_Base::SetSplit_version(void)
{
#ifdef _DEBUG
    if (!IsSetSplit_version()) {
        memset(&m_Split_version,UnassignedByte(),sizeof(m_Split_version));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Split_version;
}
 
inline
bool CID2_Request_ReGet_Blob_Base::IsSetOffset(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CID2_Request_ReGet_Blob_Base::CanGetOffset(void) const
{
    return IsSetOffset();
}
 
inline
void CID2_Request_ReGet_Blob_Base::ResetOffset(void)
{
    m_Offset = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CID2_Request_ReGet_Blob_Base::TOffset CID2_Request_ReGet_Blob_Base::GetOffset(void) const
{
    if (!CanGetOffset()) {
        ThrowUnassigned(2);
    }
    return m_Offset;
}
 
inline
void CID2_Request_ReGet_Blob_Base::SetOffset(CID2_Request_ReGet_Blob_Base::TOffset value)
{
    m_Offset = value;
    m_set_State[0] |= 0x30;
}
 
inline
CID2_Request_ReGet_Blob_Base::TOffset& CID2_Request_ReGet_Blob_Base::SetOffset(void)
{
#ifdef _DEBUG
    if (!IsSetOffset()) {
        memset(&m_Offset,UnassignedByte(),sizeof(m_Offset));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Offset;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_ID2_ID2_REQUEST_REGET_BLOB_BASE_HPP