PluginMessage_.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 PluginMessage_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.asn">gui_objects.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef GUI_OBJECTS_PLUGINMESSAGE_BASE_HPP
#define GUI_OBJECTS_PLUGINMESSAGE_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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 CPluginMessage;
class CPluginReply;
class CPluginRequest;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginMessage holds information regarding a single request to a plugin
///-
///
/// CPluginMessage_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginMessage_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginMessage_Base(void);
    // destructor
    virtual ~CPluginMessage_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TSource;
    typedef string TDestination;
    typedef string TContext;
    typedef CPluginMessage TIn_reply_to;
    typedef CPluginRequest TRequest;
    typedef CPluginReply TReply;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_source,
        e_destination,
        e_context,
        e_in_reply_to,
        e_request,
        e_reply
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// routing information
    /// source plugin
    /// Check if a value has been assigned to Source data member.
    ///
    /// Data member Source is optional;
    /// its type is defined as 'typedef string TSource'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSource(void) const;
 
    /// Check if it is safe to call GetSource method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSource(void) const;
 
    /// Reset Source data member.
    void ResetSource(void);
 
    /// Get the Source member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSource& GetSource(void) const;
 
    /// Assign a value to Source data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSource(const TSource& value);
    void SetSource(TSource&& value);
 
    /// Assign a value to Source data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSource& SetSource(void);
 
    /// destination plugin
    /// Check if a value has been assigned to Destination data member.
    ///
    /// Data member Destination is mandatory;
    /// its type is defined as 'typedef string TDestination'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDestination(void) const;
 
    /// Check if it is safe to call GetDestination method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDestination(void) const;
 
    /// Reset Destination data member.
    void ResetDestination(void);
 
    /// Get the Destination member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDestination& GetDestination(void) const;
 
    /// Assign a value to Destination data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDestination(const TDestination& value);
    void SetDestination(TDestination&& value);
 
    /// Assign a value to Destination data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDestination& SetDestination(void);
 
    ///- context in which we operate
    /// Check if a value has been assigned to Context data member.
    ///
    /// Data member Context is optional;
    /// its type is defined as 'typedef string TContext'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetContext(void) const;
 
    /// Check if it is safe to call GetContext method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetContext(void) const;
 
    /// Reset Context data member.
    void ResetContext(void);
 
    /// Get the Context member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TContext& GetContext(void) const;
 
    /// Assign a value to Context data member.
    ///
    /// @param value
    ///   Value to assign
    void SetContext(const TContext& value);
    void SetContext(TContext&& value);
 
    /// Assign a value to Context data member.
    ///
    /// @return
    ///   Reference to the data value.
    TContext& SetContext(void);
 
    ///- PluginMessage we are responding to
    /// Check if a value has been assigned to In_reply_to data member.
    ///
    /// Data member In_reply_to is optional;
    /// its type is defined as 'typedef CPluginMessage TIn_reply_to'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIn_reply_to(void) const;
 
    /// Check if it is safe to call GetIn_reply_to method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIn_reply_to(void) const;
 
    /// Reset In_reply_to data member.
    void ResetIn_reply_to(void);
 
    /// Get the In_reply_to member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TIn_reply_to& GetIn_reply_to(void) const;
 
    /// Assign a value to In_reply_to data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetIn_reply_to(TIn_reply_to& value);
 
    /// Assign a value to In_reply_to data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIn_reply_to& SetIn_reply_to(void);
 
    /// command to be passed to the plugin
    /// Check if a value has been assigned to Request data member.
    ///
    /// Data member Request is mandatory;
    /// its type is defined as 'typedef CPluginRequest TRequest'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRequest(void) const;
 
    /// Check if it is safe to call GetRequest method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRequest(void) const;
 
    /// Reset Request data member.
    void ResetRequest(void);
 
    /// Get the Request member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRequest& GetRequest(void) const;
 
    /// Assign a value to Request data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetRequest(TRequest& value);
 
    /// Assign a value to Request data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRequest& SetRequest(void);
 
    /// reply received from a plugin
    /// Check if a value has been assigned to Reply data member.
    ///
    /// Data member Reply is mandatory;
    /// its type is defined as 'typedef CPluginReply TReply'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetReply(void) const;
 
    /// Check if it is safe to call GetReply method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetReply(void) const;
 
    /// Reset Reply data member.
    void ResetReply(void);
 
    /// Get the Reply member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TReply& GetReply(void) const;
 
    /// Assign a value to Reply data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetReply(TReply& value);
 
    /// Assign a value to Reply data member.
    ///
    /// @return
    ///   Reference to the data value.
    TReply& SetReply(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginMessage_Base(const CPluginMessage_Base&);
    CPluginMessage_Base& operator=(const CPluginMessage_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Source;
    string m_Destination;
    string m_Context;
    CRef< TIn_reply_to > m_In_reply_to;
    CRef< TRequest > m_Request;
    CRef< TReply > m_Reply;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginMessage_Base::IsSetSource(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginMessage_Base::CanGetSource(void) const
{
    return IsSetSource();
}
 
inline
const CPluginMessage_Base::TSource& CPluginMessage_Base::GetSource(void) const
{
    if (!CanGetSource()) {
        ThrowUnassigned(0);
    }
    return m_Source;
}
 
inline
void CPluginMessage_Base::SetSource(const CPluginMessage_Base::TSource& value)
{
    m_Source = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPluginMessage_Base::SetSource(CPluginMessage_Base::TSource&& value)
{
    m_Source = std::forward<CPluginMessage_Base::TSource>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPluginMessage_Base::TSource& CPluginMessage_Base::SetSource(void)
{
#ifdef _DEBUG
    if (!IsSetSource()) {
        m_Source = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Source;
}
 
inline
bool CPluginMessage_Base::IsSetDestination(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginMessage_Base::CanGetDestination(void) const
{
    return IsSetDestination();
}
 
inline
const CPluginMessage_Base::TDestination& CPluginMessage_Base::GetDestination(void) const
{
    if (!CanGetDestination()) {
        ThrowUnassigned(1);
    }
    return m_Destination;
}
 
inline
void CPluginMessage_Base::SetDestination(const CPluginMessage_Base::TDestination& value)
{
    m_Destination = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPluginMessage_Base::SetDestination(CPluginMessage_Base::TDestination&& value)
{
    m_Destination = std::forward<CPluginMessage_Base::TDestination>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPluginMessage_Base::TDestination& CPluginMessage_Base::SetDestination(void)
{
#ifdef _DEBUG
    if (!IsSetDestination()) {
        m_Destination = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Destination;
}
 
inline
bool CPluginMessage_Base::IsSetContext(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CPluginMessage_Base::CanGetContext(void) const
{
    return IsSetContext();
}
 
inline
const CPluginMessage_Base::TContext& CPluginMessage_Base::GetContext(void) const
{
    if (!CanGetContext()) {
        ThrowUnassigned(2);
    }
    return m_Context;
}
 
inline
void CPluginMessage_Base::SetContext(const CPluginMessage_Base::TContext& value)
{
    m_Context = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CPluginMessage_Base::SetContext(CPluginMessage_Base::TContext&& value)
{
    m_Context = std::forward<CPluginMessage_Base::TContext>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CPluginMessage_Base::TContext& CPluginMessage_Base::SetContext(void)
{
#ifdef _DEBUG
    if (!IsSetContext()) {
        m_Context = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Context;
}
 
inline
bool CPluginMessage_Base::IsSetIn_reply_to(void) const
{
    return m_In_reply_to.NotEmpty();
}
 
inline
bool CPluginMessage_Base::CanGetIn_reply_to(void) const
{
    return IsSetIn_reply_to();
}
 
inline
const CPluginMessage_Base::TIn_reply_to& CPluginMessage_Base::GetIn_reply_to(void) const
{
    if (!CanGetIn_reply_to()) {
        ThrowUnassigned(3);
    }
    return (*m_In_reply_to);
}
 
inline
bool CPluginMessage_Base::IsSetRequest(void) const
{
    return m_Request.NotEmpty();
}
 
inline
bool CPluginMessage_Base::CanGetRequest(void) const
{
    return true;
}
 
inline
const CPluginMessage_Base::TRequest& CPluginMessage_Base::GetRequest(void) const
{
    if ( !m_Request ) {
        const_cast<CPluginMessage_Base*>(this)->ResetRequest();
    }
    return (*m_Request);
}
 
inline
CPluginMessage_Base::TRequest& CPluginMessage_Base::SetRequest(void)
{
    if ( !m_Request ) {
        ResetRequest();
    }
    return (*m_Request);
}
 
inline
bool CPluginMessage_Base::IsSetReply(void) const
{
    return m_Reply.NotEmpty();
}
 
inline
bool CPluginMessage_Base::CanGetReply(void) const
{
    return true;
}
 
inline
const CPluginMessage_Base::TReply& CPluginMessage_Base::GetReply(void) const
{
    if ( !m_Reply ) {
        const_cast<CPluginMessage_Base*>(this)->ResetReply();
    }
    return (*m_Reply);
}
 
inline
CPluginMessage_Base::TReply& CPluginMessage_Base::SetReply(void)
{
    if ( !m_Reply ) {
        ResetReply();
    }
    return (*m_Reply);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINMESSAGE_BASE_HPP