PluginReply_.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 PluginReply_.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_PLUGINREPLY_BASE_HPP
#define GUI_OBJECTS_PLUGINREPLY_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <gui/objects/MessageStatus.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 CPluginArgSet;
class CPluginReplyAction;
class CPluginValue;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginReply defines the responses received from a plugin after completion
///- of its activities.
///-
///
/// CPluginReply_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginReply_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginReply_Base(void);
    // destructor
    virtual ~CPluginReply_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef EMessageStatus TStatus;
    typedef list< CRef< CPluginReplyAction > > TAction;
    typedef list< CRef< CPluginValue > > TRaw;
    typedef CPluginArgSet TFormatted;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_status,
        e_action,
        e_raw,
        e_formatted
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Status data member.
    ///
    /// Data member Status is optional with default eMessageStatus_failed;
    /// its type is defined as 'typedef EMessageStatus 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);
 
    /// Assign default value to Status data member.
    void SetDefaultStatus(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 Action data member.
    ///
    /// Data member Action is optional;
    /// its type is defined as 'typedef list< CRef< CPluginReplyAction > > TAction'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAction(void) const;
 
    /// Check if it is safe to call GetAction method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAction(void) const;
 
    /// Reset Action data member.
    void ResetAction(void);
 
    /// Get the Action member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAction& GetAction(void) const;
 
    /// Assign a value to Action data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAction& SetAction(void);
 
    /// things we've produced
    /// Check if a value has been assigned to Raw data member.
    ///
    /// Data member Raw is optional;
    /// its type is defined as 'typedef list< CRef< CPluginValue > > TRaw'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRaw(void) const;
 
    /// Check if it is safe to call GetRaw method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRaw(void) const;
 
    /// Reset Raw data member.
    void ResetRaw(void);
 
    /// Get the Raw member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRaw& GetRaw(void) const;
 
    /// Assign a value to Raw data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRaw& SetRaw(void);
 
    /// caller-defined args
    /// Check if a value has been assigned to Formatted data member.
    ///
    /// Data member Formatted is optional;
    /// its type is defined as 'typedef CPluginArgSet TFormatted'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFormatted(void) const;
 
    /// Check if it is safe to call GetFormatted method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFormatted(void) const;
 
    /// Reset Formatted data member.
    void ResetFormatted(void);
 
    /// Get the Formatted member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFormatted& GetFormatted(void) const;
 
    /// Assign a value to Formatted data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetFormatted(TFormatted& value);
 
    /// Assign a value to Formatted data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFormatted& SetFormatted(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginReply_Base(const CPluginReply_Base&);
    CPluginReply_Base& operator=(const CPluginReply_Base&);
 
    // data
    Uint4 m_set_State[1];
    EMessageStatus m_Status;
    list< CRef< CPluginReplyAction > > m_Action;
    list< CRef< CPluginValue > > m_Raw;
    CRef< TFormatted > m_Formatted;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginReply_Base::IsSetStatus(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginReply_Base::CanGetStatus(void) const
{
    return true;
}
 
inline
void CPluginReply_Base::ResetStatus(void)
{
    m_Status = eMessageStatus_failed;
    m_set_State[0] &= ~0x3;
}
 
inline
void CPluginReply_Base::SetDefaultStatus(void)
{
    ResetStatus();
}
 
inline
CPluginReply_Base::TStatus CPluginReply_Base::GetStatus(void) const
{
    return m_Status;
}
 
inline
void CPluginReply_Base::SetStatus(CPluginReply_Base::TStatus value)
{
    m_Status = value;
    m_set_State[0] |= 0x3;
}
 
inline
CPluginReply_Base::TStatus& CPluginReply_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 CPluginReply_Base::IsSetAction(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginReply_Base::CanGetAction(void) const
{
    return true;
}
 
inline
const CPluginReply_Base::TAction& CPluginReply_Base::GetAction(void) const
{
    return m_Action;
}
 
inline
CPluginReply_Base::TAction& CPluginReply_Base::SetAction(void)
{
    m_set_State[0] |= 0x4;
    return m_Action;
}
 
inline
bool CPluginReply_Base::IsSetRaw(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CPluginReply_Base::CanGetRaw(void) const
{
    return true;
}
 
inline
const CPluginReply_Base::TRaw& CPluginReply_Base::GetRaw(void) const
{
    return m_Raw;
}
 
inline
CPluginReply_Base::TRaw& CPluginReply_Base::SetRaw(void)
{
    m_set_State[0] |= 0x10;
    return m_Raw;
}
 
inline
bool CPluginReply_Base::IsSetFormatted(void) const
{
    return m_Formatted.NotEmpty();
}
 
inline
bool CPluginReply_Base::CanGetFormatted(void) const
{
    return IsSetFormatted();
}
 
inline
const CPluginReply_Base::TFormatted& CPluginReply_Base::GetFormatted(void) const
{
    if (!CanGetFormatted()) {
        ThrowUnassigned(3);
    }
    return (*m_Formatted);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINREPLY_BASE_HPP