TMgr_SeqTrackIdReply_.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 TMgr_SeqTrackIdReply_.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/trackmgr/trackmgr.asn">trackmgr.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/trackmgr/trackmgr.def">trackmgr.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_TRACKMGR_TMGR_SEQTRACKIDREPLY_BASE_HPP
#define OBJECTS_TRACKMGR_TMGR_SEQTRACKIDREPLY_BASE_HPP
 
// extra headers
#include <objects/trackmgr/trackmgr_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <objects/trackmgr/TMgr_Status.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 CTMgr_DTrackId;
class CTMgr_Message;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_TrackManager
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CTMgr_SeqTrackIdReply_Base --
///
 
class NCBI_TRACKMGR_EXPORT CTMgr_SeqTrackIdReply_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTMgr_SeqTrackIdReply_Base(void);
    // destructor
    virtual ~CTMgr_SeqTrackIdReply_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TStatus;
    typedef list< CRef< CTMgr_Message > > TMessages;
    typedef CTMgr_DTrackId TDtrack_id;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_status,
        e_messages,
        e_dtrack_id
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Status data member.
    ///
    /// Data member Status is mandatory;
    /// its type is defined as 'typedef int TStatus'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStatus(void) const;
 
    /// Check if it is safe to call GetStatus method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStatus(void) const;
 
    /// Reset Status data member.
    void ResetStatus(void);
 
    /// Get the Status member data.
    ///
    /// @return
    ///   Copy of the member data.
    TStatus GetStatus(void) const;
 
    /// Assign a value to Status data member.
    ///
    /// @param value
    ///   Value to assign
    void SetStatus(TStatus value);
 
    /// Assign a value to Status data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStatus& SetStatus(void);
 
    /// Check if a value has been assigned to Messages data member.
    ///
    /// Data member Messages is optional;
    /// its type is defined as 'typedef list< CRef< CTMgr_Message > > TMessages'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMessages(void) const;
 
    /// Check if it is safe to call GetMessages method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMessages(void) const;
 
    /// Reset Messages data member.
    void ResetMessages(void);
 
    /// Get the Messages member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMessages& GetMessages(void) const;
 
    /// Assign a value to Messages data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMessages& SetMessages(void);
 
    /// Check if a value has been assigned to Dtrack_id data member.
    ///
    /// Data member Dtrack_id is optional;
    /// its type is defined as 'typedef CTMgr_DTrackId TDtrack_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDtrack_id(void) const;
 
    /// Check if it is safe to call GetDtrack_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDtrack_id(void) const;
 
    /// Reset Dtrack_id data member.
    void ResetDtrack_id(void);
 
    /// Get the Dtrack_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDtrack_id& GetDtrack_id(void) const;
 
    /// Assign a value to Dtrack_id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetDtrack_id(TDtrack_id& value);
 
    /// Assign a value to Dtrack_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDtrack_id& SetDtrack_id(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CTMgr_SeqTrackIdReply_Base(const CTMgr_SeqTrackIdReply_Base&);
    CTMgr_SeqTrackIdReply_Base& operator=(const CTMgr_SeqTrackIdReply_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Status;
    list< CRef< CTMgr_Message > > m_Messages;
    CRef< TDtrack_id > m_Dtrack_id;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CTMgr_SeqTrackIdReply_Base::IsSetStatus(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CTMgr_SeqTrackIdReply_Base::CanGetStatus(void) const
{
    return IsSetStatus();
}
 
inline
void CTMgr_SeqTrackIdReply_Base::ResetStatus(void)
{
    m_Status = (int)(0);
    m_set_State[0] &= ~0x3;
}
 
inline
CTMgr_SeqTrackIdReply_Base::TStatus CTMgr_SeqTrackIdReply_Base::GetStatus(void) const
{
    if (!CanGetStatus()) {
        ThrowUnassigned(0);
    }
    return m_Status;
}
 
inline
void CTMgr_SeqTrackIdReply_Base::SetStatus(CTMgr_SeqTrackIdReply_Base::TStatus value)
{
    m_Status = value;
    m_set_State[0] |= 0x3;
}
 
inline
CTMgr_SeqTrackIdReply_Base::TStatus& CTMgr_SeqTrackIdReply_Base::SetStatus(void)
{
#ifdef _DEBUG
    if (!IsSetStatus()) {
        memset(&m_Status,UnassignedByte(),sizeof(m_Status));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Status;
}
 
inline
bool CTMgr_SeqTrackIdReply_Base::IsSetMessages(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CTMgr_SeqTrackIdReply_Base::CanGetMessages(void) const
{
    return true;
}
 
inline
const CTMgr_SeqTrackIdReply_Base::TMessages& CTMgr_SeqTrackIdReply_Base::GetMessages(void) const
{
    return m_Messages;
}
 
inline
CTMgr_SeqTrackIdReply_Base::TMessages& CTMgr_SeqTrackIdReply_Base::SetMessages(void)
{
    m_set_State[0] |= 0x4;
    return m_Messages;
}
 
inline
bool CTMgr_SeqTrackIdReply_Base::IsSetDtrack_id(void) const
{
    return m_Dtrack_id.NotEmpty();
}
 
inline
bool CTMgr_SeqTrackIdReply_Base::CanGetDtrack_id(void) const
{
    return IsSetDtrack_id();
}
 
inline
const CTMgr_SeqTrackIdReply_Base::TDtrack_id& CTMgr_SeqTrackIdReply_Base::GetDtrack_id(void) const
{
    if (!CanGetDtrack_id()) {
        ThrowUnassigned(2);
    }
    return (*m_Dtrack_id);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_TRACKMGR_TMGR_SEQTRACKIDREPLY_BASE_HPP