dtk_global_data_set.hpp

Go to the documentation of this file.

#ifndef _DTK_GLOBAL_DATA_SET_HPP_
#define _DTK_GLOBAL_DATA_SET_HPP_
 
#include "util_selection_set.hpp"
#include "util/dtk_global_data_set_ptr.hpp"
#include "util/dtk_fdt_set.hpp"
#include "def/define.h"
#include "util/BaseTypes/dtk_object.hpp"
 
class Dtk_SelectionDataSet : public Dtk_Object
{
protected:
 
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
 
    //! \sa Create() 
    Dtk_SelectionDataSet();
 
    //! \sa Create(const Dtk_SelectionDataSet&)
    Dtk_SelectionDataSet(const Dtk_SelectionDataSet &s);
    inline virtual Dtk_Object* Clone() { return new Dtk_SelectionDataSet(*this); }
 
    //! \BaseDestructor 
    ~Dtk_SelectionDataSet();
 
    enum { _typeID = DTK_TYPE_SELECTION_DATA_SET }; 
 
private:
    void _Init();
    void _Copy(const Dtk_SelectionDataSet &s);
    void _Reset();
    friend class Dtk_SmartPtr< Dtk_SelectionDataSet >;
public:
    //! \DtkDynamicType
    Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId);
 
    //! \DtkDynamicCast
    static Dtk_SelectionDataSet * DtkDynamicCast(Dtk_Object *s);
 
    //! \return The type of the entity type - DTK_TYPE_SELECTION_DATA_SET - 
    type_detk get_type_detk() const { return DTK_TYPE_SELECTION_DATA_SET; }
 
    //! \CreateBase
    static Dtk_SelectionDataSetPtr Create();
 
    //! \brief Retrieves the number of Selection sets.
    //! \return the number of Selection sets.
    Dtk_Size_t GetNumSelectionSets() const;
 
    //! \brief Retrieves the ith Dtk_SelectionSetPtr giving its index.
    //! \param inPos index of the Dtk_SelectionSetPtr.
    //! \return the ith Dtk_SelectionSetPtr.
    Dtk_SelectionSetPtr GetSelectionSetByPos(const Dtk_Size_t inPos) const;
 
    //! \brief Adds a Dtk_SelectionSetPtr to the selection sets pool.
    //! \param inSelectionSet The Dtk_SelectionSetPtr to be added.
    //! \return the Dtk_SelectionSetPtr index.
    Dtk_Size_t AddSelectionSet(const Dtk_SelectionSetPtr& inSelectionSet);
 
};
 
//////////////////////////////////////////////////////////////////////////
 
class Dtk_FdtDataSet : public Dtk_Object
{
protected:
 
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
 
    //! \sa Create() 
    Dtk_FdtDataSet();
 
    //! \sa Create(const Dtk_SelectionDataSet&)
    Dtk_FdtDataSet(const Dtk_FdtDataSet &s);
    inline virtual Dtk_Object* Clone() { return new Dtk_FdtDataSet(*this); }
 
    //! \BaseDestructor 
    ~Dtk_FdtDataSet();
 
    enum { _typeID = DTK_TYPE_FDT_DATA_SET}; 
 
private:
    void _Init();
    void _Copy(const Dtk_FdtDataSet &s);
    void _Reset();
    friend class Dtk_SmartPtr< Dtk_FdtDataSet >;
public:
    //! \DtkDynamicType
    Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId);
 
    //! \DtkDynamicCast
    static Dtk_FdtDataSet * DtkDynamicCast(Dtk_Object *s);
 
    //! \return The type of the entity type - DTK_TYPE_FDT_DATA_SET - 
    type_detk get_type_detk() const { return DTK_TYPE_FDT_DATA_SET; }
 
    //! \CreateBase
    static Dtk_FdtDataSetPtr Create();
 
    //! \brief Retrieves the number of Selection sets.
    //! \param inPos Child element index.
    //! \return the number of Selection sets.
    Dtk_Size_t GetNumFdtSets() const;
 
    //! \brief Retrieves the ith Dtk_SelectionSetPtr giving its index.
    //! \param inPos index of the Dtk_SelectionSetPtr.
    //! \return the ith Dtk_SelectionSetPtr.
    Dtk_FdtSetPackage::Dtk_FdtSetPtr GetFdtSetByPos(const Dtk_Size_t inPos) const;
 
    //! \brief Adds a Dtk_SelectionSetPtr to the selection sets pool.
    //! \param inSelectionSet The Dtk_SelectionSetPtr to be added.
    //! \return the Dtk_SelectionSetPtr index.
    Dtk_Size_t AddFdtSet(const Dtk_FdtSetPackage::Dtk_FdtSetPtr& inFdtSet);
 
};
 
 
//////////////////////////////////////////////////////////////////////////
class Dtk_GlobalDataSet : public Dtk_Object
{
protected:
 
    struct Dtk_Handle;      // Not defined here
    Dtk_Handle *_Private;   // Handle
 
    //! \sa Create() 
    Dtk_GlobalDataSet();
 
    //! \sa Create(const Dtk_FdtAnnotationSet&)
    Dtk_GlobalDataSet(const Dtk_GlobalDataSet &s);
    inline virtual Dtk_Object* Clone() { return new Dtk_GlobalDataSet(*this); }
 
    //! \BaseDestructor 
    ~Dtk_GlobalDataSet();
 
    enum { _typeID = DTK_TYPE_GLOBAL_DATA_SET }; 
 
private:
    void _Init();
    void _Copy(const Dtk_GlobalDataSet &s);
    void _Reset();
    friend class Dtk_SmartPtr<Dtk_GlobalDataSet>;
public:
    //! \DtkDynamicType
    Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId);
 
    //! \DtkDynamicCast
    static Dtk_GlobalDataSet * DtkDynamicCast(Dtk_Object *s);
 
    //! \return The type of the entity type - DTK_TYPE_GLOBAL_DATA_SET - 
    type_detk get_type_detk() const { return DTK_TYPE_GLOBAL_DATA_SET; }
 
    //! \CreateBase
    static Dtk_GlobalDataSetPtr Create();
 
    //! \brief Retrieves the SelectionDataSet.
    //! \return the Dtk_SelectionDataSetPtr - can be null -.
    const Dtk_SelectionDataSetPtr GetSelectionDataSet() const;
 
    //! \brief Set The SelectionDataSet infos - for internal use only -.
    //! \param inSelectionDataSet The Dtk_SelectionDataSetPtr to be added.
    void SetSelectionDataSet( const Dtk_SelectionDataSetPtr& inSelectionDataSet);
 
    //! \brief Retrieves the FdtDataSet.
    //! \return the Dtk_FdtDataSetPtr - can be null -.
    const Dtk_FdtDataSetPtr GetFdtDataSet() const;
 
    //! \brief Set The FdtDataSet infos - for internal use only -.
    //! \param inFdtDataSet The Dtk_FdtDataSetPtr to be added.
    void SetFdtDataSet( const Dtk_FdtDataSetPtr& inFdtDataSet);
 
};
 
 
 
#endif