PluginValue_.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 PluginValue_.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_PLUGINVALUE_BASE_HPP
#define GUI_OBJECTS_PLUGINVALUE_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 CPluginObject;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginValue variant
///-
///
/// CPluginValue_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginValue_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginValue_Base(void);
    // destructor
    virtual ~CPluginValue_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,    ///< No variant selected
        e_Integer,
        e_Double,
        e_String,
        e_Secret_string,
        e_Input_file,
        e_Output_file,
        e_Boolean,
        e_Project,
        e_DataHandle,
        e_Object
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 11 ///< == e_Object+1
    };
 
    /// Reset the whole object
    virtual void Reset(void);
 
    /// Reset the selection (set it to e_not_set).
    virtual void ResetSelection(void);
 
    /// Which variant is currently selected.
    ///
    /// @return
    ///   Choice state enumerator.
    E_Choice Which(void) const;
 
    /// Verify selection, throw exception if it differs from the expected.
    ///
    /// @param index
    ///   Expected selection.
    void CheckSelected(E_Choice index) const;
 
    /// Throw 'InvalidSelection' exception.
    ///
    /// @param index
    ///   Expected selection.
    NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
 
    /// Retrieve selection name (for diagnostic purposes).
    ///
    /// @param index
    ///   One of possible selection states.
    /// @return
    ///   Name string.
    static string SelectionName(E_Choice index);
 
    /// Select the requested variant if needed.
    ///
    /// @param index
    ///   New selection state.
    /// @param reset
    ///   Flag that defines the resetting of the variant data. The data will
    ///   be reset if either the current selection differs from the new one,
    ///   or the flag is set to eDoResetVariant.
    void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
    /// Select the requested variant if needed,
    /// allocating CObject variants from memory pool.
    void Select(E_Choice index,
                EResetVariant reset,
                CObjectMemoryPool* pool);
 
    // types
    typedef string TInteger;
    typedef string TDouble;
    typedef string TString;
    typedef string TSecret_string;
    typedef string TInput_file;
    typedef string TOutput_file;
    typedef string TBoolean;
    typedef CPluginObject TProject;
    typedef CPluginObject TDataHandle;
    typedef CPluginObject TObject;
 
    // getters
    // setters
 
 
    /// Check if variant Integer is selected.
    ///
    /// Integer type is defined as 'typedef string TInteger'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsInteger(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TInteger& GetInteger(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TInteger& SetInteger(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetInteger(const TInteger& value);
 
 
    /// Check if variant Double is selected.
    ///
    /// Double type is defined as 'typedef string TDouble'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsDouble(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TDouble& GetDouble(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TDouble& SetDouble(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetDouble(const TDouble& value);
 
 
    /// Check if variant String is selected.
    ///
    /// String type is defined as 'typedef string TString'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsString(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TString& GetString(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TString& SetString(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetString(const TString& value);
 
 
    /// Check if variant Secret_string is selected.
    ///
    /// Secret_string type is defined as 'typedef string TSecret_string'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsSecret_string(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TSecret_string& GetSecret_string(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TSecret_string& SetSecret_string(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetSecret_string(const TSecret_string& value);
 
 
    /// Check if variant Input_file is selected.
    ///
    /// Input_file type is defined as 'typedef string TInput_file'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsInput_file(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TInput_file& GetInput_file(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TInput_file& SetInput_file(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetInput_file(const TInput_file& value);
 
 
    /// Check if variant Output_file is selected.
    ///
    /// Output_file type is defined as 'typedef string TOutput_file'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsOutput_file(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TOutput_file& GetOutput_file(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TOutput_file& SetOutput_file(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetOutput_file(const TOutput_file& value);
 
 
    /// Check if variant Boolean is selected.
    ///
    /// Boolean type is defined as 'typedef string TBoolean'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsBoolean(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TBoolean& GetBoolean(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TBoolean& SetBoolean(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetBoolean(const TBoolean& value);
 
 
    /// Check if variant Project is selected.
    ///
    /// Project type is defined as 'typedef CPluginObject TProject'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsProject(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TProject& GetProject(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TProject& SetProject(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetProject(TProject& value);
 
 
    /// Check if variant DataHandle is selected.
    ///
    /// DataHandle type is defined as 'typedef CPluginObject TDataHandle'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsDataHandle(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TDataHandle& GetDataHandle(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TDataHandle& SetDataHandle(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetDataHandle(TDataHandle& value);
 
 
    /// Check if variant Object is selected.
    ///
    /// Object type is defined as 'typedef CPluginObject TObject'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsObject(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TObject& GetObject(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TObject& SetObject(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetObject(TObject& value);
 
 
private:
    // copy constructor and assignment operator
    CPluginValue_Base(const CPluginValue_Base& );
    CPluginValue_Base& operator=(const CPluginValue_Base& );
    // choice state
    E_Choice m_choice;
    // helper methods
    void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
 
    static const char* const sm_SelectionNames[];
    // data
    union {
        NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CPluginValue_Base::E_Choice CPluginValue_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CPluginValue_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CPluginValue_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CPluginValue_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CPluginValue_Base::IsInteger(void) const
{
    return m_choice == e_Integer;
}
 
inline
const CPluginValue_Base::TInteger& CPluginValue_Base::GetInteger(void) const
{
    CheckSelected(e_Integer);
    return *m_string;
}
 
inline
CPluginValue_Base::TInteger& CPluginValue_Base::SetInteger(void)
{
    Select(e_Integer, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsDouble(void) const
{
    return m_choice == e_Double;
}
 
inline
const CPluginValue_Base::TDouble& CPluginValue_Base::GetDouble(void) const
{
    CheckSelected(e_Double);
    return *m_string;
}
 
inline
CPluginValue_Base::TDouble& CPluginValue_Base::SetDouble(void)
{
    Select(e_Double, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsString(void) const
{
    return m_choice == e_String;
}
 
inline
const CPluginValue_Base::TString& CPluginValue_Base::GetString(void) const
{
    CheckSelected(e_String);
    return *m_string;
}
 
inline
CPluginValue_Base::TString& CPluginValue_Base::SetString(void)
{
    Select(e_String, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsSecret_string(void) const
{
    return m_choice == e_Secret_string;
}
 
inline
const CPluginValue_Base::TSecret_string& CPluginValue_Base::GetSecret_string(void) const
{
    CheckSelected(e_Secret_string);
    return *m_string;
}
 
inline
CPluginValue_Base::TSecret_string& CPluginValue_Base::SetSecret_string(void)
{
    Select(e_Secret_string, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsInput_file(void) const
{
    return m_choice == e_Input_file;
}
 
inline
const CPluginValue_Base::TInput_file& CPluginValue_Base::GetInput_file(void) const
{
    CheckSelected(e_Input_file);
    return *m_string;
}
 
inline
CPluginValue_Base::TInput_file& CPluginValue_Base::SetInput_file(void)
{
    Select(e_Input_file, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsOutput_file(void) const
{
    return m_choice == e_Output_file;
}
 
inline
const CPluginValue_Base::TOutput_file& CPluginValue_Base::GetOutput_file(void) const
{
    CheckSelected(e_Output_file);
    return *m_string;
}
 
inline
CPluginValue_Base::TOutput_file& CPluginValue_Base::SetOutput_file(void)
{
    Select(e_Output_file, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsBoolean(void) const
{
    return m_choice == e_Boolean;
}
 
inline
const CPluginValue_Base::TBoolean& CPluginValue_Base::GetBoolean(void) const
{
    CheckSelected(e_Boolean);
    return *m_string;
}
 
inline
CPluginValue_Base::TBoolean& CPluginValue_Base::SetBoolean(void)
{
    Select(e_Boolean, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginValue_Base::IsProject(void) const
{
    return m_choice == e_Project;
}
 
inline
bool CPluginValue_Base::IsDataHandle(void) const
{
    return m_choice == e_DataHandle;
}
 
inline
bool CPluginValue_Base::IsObject(void) const
{
    return m_choice == e_Object;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINVALUE_BASE_HPP