PlistObject_.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 PlistObject_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/property_list.xsd">property_list.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/property_list.def">property_list.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef BUILD_SYSTEM_PROJECT_TREE_BUILDER_PLISTOBJECT_BASE_HPP
#define BUILD_SYSTEM_PROJECT_TREE_BUILDER_PLISTOBJECT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
#include <vector>
 
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 CArray;
class CDict;
 
 
// generated classes
 
 
/** @addtogroup dataspec_property_list
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CPlistObject_Base --
///
 
class CPlistObject_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPlistObject_Base(void);
    // destructor
    virtual ~CPlistObject_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,  ///< No variant selected
        e_Array,
        e_Data,         ///< Contents interpreted as Base-64 encoded   
        e_Date,         ///< Contents should conform to a subset of ISO 8601 (in particular, YYYY '-' MM '-' DD 'T' HH ':' MM ':' SS 'Z'.  Smaller units may be omitted with a loss of precision)  
        e_Dict,
        e_Real,         ///< Contents should represent a floating point number matching ("+" | "-")? d+ ("."d*)? ("E" ("+" | "-") d+)? where d is a digit 0-9.   
        e_Integer,      ///< Contents should represent a (possibly signed) integer number in base 10   
        e_String,       ///<- Primitive types   
        e_True,         ///< Boolean constant true  
        e_False         ///< Boolean constant false   
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 10 ///< == e_False+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 CArray TArray;
    typedef vector< char > TData;
    typedef string TDate;
    typedef CDict TDict;
    typedef double TReal;
    typedef int TInteger;
    typedef string TString;
 
    // getters
    // setters
 
 
    /// Check if variant Array is selected.
    ///
    /// Array type is defined as 'typedef CArray TArray'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsArray(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TArray& GetArray(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TArray& SetArray(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetArray(TArray& value);
 
 
    /// Check if variant Data is selected.
    ///
    /// Data type is defined as 'typedef vector< char > TData'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsData(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TData& GetData(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TData& SetData(void);
 
 
    /// Check if variant Date is selected.
    ///
    /// Date type is defined as 'typedef string TDate'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsDate(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TDate& GetDate(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TDate& SetDate(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetDate(const TDate& value);
 
 
    /// Check if variant Dict is selected.
    ///
    /// Dict type is defined as 'typedef CDict TDict'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsDict(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TDict& GetDict(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TDict& SetDict(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetDict(TDict& value);
 
 
    /// Check if variant Real is selected.
    ///
    /// Real type is defined as 'typedef double TReal'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsReal(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TReal GetReal(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TReal& SetReal(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetReal(TReal value);
 
 
    /// Check if variant Integer is selected.
    ///
    /// Integer type is defined as 'typedef int TInteger'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsInteger(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    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(TInteger 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 True is selected.
    ///
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsTrue(void) const;
 
    /// Select the variant.
    void SetTrue(void);
 
 
    /// Check if variant False is selected.
    ///
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsFalse(void) const;
 
    /// Select the variant.
    void SetFalse(void);
 
 
private:
    // copy constructor and assignment operator
    CPlistObject_Base(const CPlistObject_Base& );
    CPlistObject_Base& operator=(const CPlistObject_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<TData> m_Data;
        TReal m_Real;
        TInteger m_Integer;
        NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CPlistObject_Base::E_Choice CPlistObject_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CPlistObject_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CPlistObject_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 CPlistObject_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CPlistObject_Base::IsArray(void) const
{
    return m_choice == e_Array;
}
 
inline
bool CPlistObject_Base::IsData(void) const
{
    return m_choice == e_Data;
}
 
inline
const CPlistObject_Base::TData& CPlistObject_Base::GetData(void) const
{
    CheckSelected(e_Data);
    return *m_Data;
}
 
inline
CPlistObject_Base::TData& CPlistObject_Base::SetData(void)
{
    Select(e_Data, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_Data;
}
 
inline
bool CPlistObject_Base::IsDate(void) const
{
    return m_choice == e_Date;
}
 
inline
const CPlistObject_Base::TDate& CPlistObject_Base::GetDate(void) const
{
    CheckSelected(e_Date);
    return *m_string;
}
 
inline
CPlistObject_Base::TDate& CPlistObject_Base::SetDate(void)
{
    Select(e_Date, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPlistObject_Base::IsDict(void) const
{
    return m_choice == e_Dict;
}
 
inline
bool CPlistObject_Base::IsReal(void) const
{
    return m_choice == e_Real;
}
 
inline
CPlistObject_Base::TReal CPlistObject_Base::GetReal(void) const
{
    CheckSelected(e_Real);
    return m_Real;
}
 
inline
CPlistObject_Base::TReal& CPlistObject_Base::SetReal(void)
{
    Select(e_Real, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Real;
}
 
inline
void CPlistObject_Base::SetReal(CPlistObject_Base::TReal value)
{
    Select(e_Real, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Real = value;
}
 
inline
bool CPlistObject_Base::IsInteger(void) const
{
    return m_choice == e_Integer;
}
 
inline
CPlistObject_Base::TInteger CPlistObject_Base::GetInteger(void) const
{
    CheckSelected(e_Integer);
    return m_Integer;
}
 
inline
CPlistObject_Base::TInteger& CPlistObject_Base::SetInteger(void)
{
    Select(e_Integer, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Integer;
}
 
inline
void CPlistObject_Base::SetInteger(CPlistObject_Base::TInteger value)
{
    Select(e_Integer, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Integer = value;
}
 
inline
bool CPlistObject_Base::IsString(void) const
{
    return m_choice == e_String;
}
 
inline
const CPlistObject_Base::TString& CPlistObject_Base::GetString(void) const
{
    CheckSelected(e_String);
    return *m_string;
}
 
inline
CPlistObject_Base::TString& CPlistObject_Base::SetString(void)
{
    Select(e_String, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPlistObject_Base::IsTrue(void) const
{
    return m_choice == e_True;
}
 
inline
void CPlistObject_Base::SetTrue(void)
{
    Select(e_True, NCBI_NS_NCBI::eDoNotResetVariant);
}
 
inline
bool CPlistObject_Base::IsFalse(void) const
{
    return m_choice == e_False;
}
 
inline
void CPlistObject_Base::SetFalse(void)
{
    Select(e_False, NCBI_NS_NCBI::eDoNotResetVariant);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // BUILD_SYSTEM_PROJECT_TREE_BUILDER_PLISTOBJECT_BASE_HPP