DATAKIT SDK  V2026.4
dtk_global_data_set.hpp
Go to the documentation of this file.
1 #ifndef _DTK_GLOBAL_DATA_SET_HPP_
2 #define _DTK_GLOBAL_DATA_SET_HPP_
3 
4 #include "util_selection_set.hpp"
6 #include "util/dtk_fdt_set.hpp"
7 #include "def/define.h"
9 #include <memory>
10 
12 {
13 protected:
14 
15  struct Dtk_Handle; // Not defined here
16  std::unique_ptr<Dtk_Handle> _Private; // Handle
17 
18  //! \sa Create()
20 
21  //! \sa Create(const Dtk_SelectionDataSet&)
23  inline virtual Dtk_Object* Clone() { return new Dtk_SelectionDataSet(*this); }
24 
25  //! \BaseDestructor
27 
29 
30  friend class Dtk_SmartPtr< Dtk_SelectionDataSet >;
31 public:
32  //! \DtkDynamicType
34 
35  //! \DtkDynamicCast
37 
38  //! \return The type of the entity type - DTK_TYPE_SELECTION_DATA_SET -
40 
41  //! \CreateBase
43 
44  //! \brief Retrieves the number of Selection sets.
45  //! \return the number of Selection sets.
47 
48  //! \brief Retrieves the ith Dtk_SelectionSetPtr giving its index.
49  //! \param inPos index of the Dtk_SelectionSetPtr.
50  //! \return the ith Dtk_SelectionSetPtr.
52 
53  //! \brief Adds a Dtk_SelectionSetPtr to the selection sets pool.
54  //! \param inSelectionSet The Dtk_SelectionSetPtr to be added.
55  //! \return the Dtk_SelectionSetPtr index.
57 
58 };
59 
60 //////////////////////////////////////////////////////////////////////////
61 
62 class Dtk_FdtDataSet : public Dtk_Object
63 {
64 protected:
65 
66  struct Dtk_Handle; // Not defined here
67  std::unique_ptr<Dtk_Handle> _Private; // Handle
68 
69  //! \sa Create()
71 
72  //! \sa Create(const Dtk_SelectionDataSet&)
74  inline virtual Dtk_Object* Clone() { return new Dtk_FdtDataSet(*this); }
75 
76  //! \BaseDestructor
78 
80 
81  friend class Dtk_SmartPtr< Dtk_FdtDataSet >;
82 public:
83  //! \DtkDynamicType
85 
86  //! \DtkDynamicCast
88 
89  //! \return The type of the entity type - DTK_TYPE_FDT_DATA_SET -
91 
92  //! \CreateBase
94 
95  //! \brief Retrieves the number of Selection sets.
96  //! \param inPos Child element index.
97  //! \return the number of Selection sets.
99 
100  //! \brief Retrieves the ith Dtk_SelectionSetPtr giving its index.
101  //! \param inPos index of the Dtk_SelectionSetPtr.
102  //! \return the ith Dtk_SelectionSetPtr.
104 
105  //! \brief Adds a Dtk_SelectionSetPtr to the selection sets pool.
106  //! \param inSelectionSet The Dtk_SelectionSetPtr to be added.
107  //! \return the Dtk_SelectionSetPtr index.
109 
110 };
111 
112 
113 //////////////////////////////////////////////////////////////////////////
115 {
116 protected:
117 
118  struct Dtk_Handle; // Not defined here
119  std::unique_ptr<Dtk_Handle> _Private; // Handle
120 
121  //! \sa Create()
123 
124  //! \sa Create(const Dtk_FdtAnnotationSet&)
126  inline virtual Dtk_Object* Clone() { return new Dtk_GlobalDataSet(*this); }
127 
128  //! \BaseDestructor
130 
132 
133  friend class Dtk_SmartPtr<Dtk_GlobalDataSet>;
134 public:
135  //! \DtkDynamicType
137 
138  //! \DtkDynamicCast
140 
141  //! \return The type of the entity type - DTK_TYPE_GLOBAL_DATA_SET -
143 
144  //! \CreateBase
146 
147  //! \brief Retrieves the SelectionDataSet.
148  //! \return the Dtk_SelectionDataSetPtr - can be null -.
150 
151  //! \brief Set The SelectionDataSet infos - for internal use only -.
152  //! \param inSelectionDataSet The Dtk_SelectionDataSetPtr to be added.
153  void SetSelectionDataSet( const Dtk_SelectionDataSetPtr& inSelectionDataSet);
154 
155  //! \brief Retrieves the FdtDataSet.
156  //! \return the Dtk_FdtDataSetPtr - can be null -.
158 
159  //! \brief Set The FdtDataSet infos - for internal use only -.
160  //! \param inFdtDataSet The Dtk_FdtDataSetPtr to be added.
161  void SetFdtDataSet( const Dtk_FdtDataSetPtr& inFdtDataSet);
162 
163 };
164 
165 
166 
167 #endif
Dtk_FdtDataSet::_Private
std::unique_ptr< Dtk_Handle > _Private
Definition: dtk_global_data_set.hpp:66
Dtk_FdtDataSet::Dtk_FdtDataSet
Dtk_FdtDataSet(const Dtk_FdtDataSet &s)
dtk_global_data_set_ptr.hpp
Dtk_GlobalDataSet::_Private
std::unique_ptr< Dtk_Handle > _Private
Definition: dtk_global_data_set.hpp:118
Dtk_FdtDataSet::Dtk_FdtDataSet
Dtk_FdtDataSet()
Dtk_SelectionDataSet::get_type_detk
type_detk get_type_detk() const
Definition: dtk_global_data_set.hpp:39
Dtk_FdtDataSet::~Dtk_FdtDataSet
~Dtk_FdtDataSet()
Destructor.
Dtk_FdtDataSet::get_type_detk
type_detk get_type_detk() const
Definition: dtk_global_data_set.hpp:90
Dtk_GlobalDataSet::Create
static Dtk_GlobalDataSetPtr Create()
Calls default constructor to allocate a new object.
Dtk_GlobalDataSet::get_type_detk
type_detk get_type_detk() const
Definition: dtk_global_data_set.hpp:142
Dtk_FdtDataSet::GetFdtSetByPos
Dtk_FdtSetPackage::Dtk_FdtSetPtr GetFdtSetByPos(const Dtk_Size_t inPos) const
Retrieves the ith Dtk_SelectionSetPtr giving its index.
DTK_TYPE_SELECTION_DATA_SET
@ DTK_TYPE_SELECTION_DATA_SET
Definition: define.h:446
Dtk_GlobalDataSet::SetSelectionDataSet
void SetSelectionDataSet(const Dtk_SelectionDataSetPtr &inSelectionDataSet)
Set The SelectionDataSet infos - for internal use only -.
Dtk_Size_t
size_t Dtk_Size_t
Definition: define.h:711
Dtk_GlobalDataSet::Dtk_GlobalDataSet
Dtk_GlobalDataSet()
DTK_TYPE_FDT_DATA_SET
@ DTK_TYPE_FDT_DATA_SET
Definition: define.h:448
Dtk_GlobalDataSet::DtkDynamicType
Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
Retrieves the dynamic entity type.
Dtk_SelectionDataSet::AddSelectionSet
Dtk_Size_t AddSelectionSet(const Dtk_SelectionSetPtr &inSelectionSet)
Adds a Dtk_SelectionSetPtr to the selection sets pool.
Dtk_SelectionDataSet::Create
static Dtk_SelectionDataSetPtr Create()
Calls default constructor to allocate a new object.
Dtk_GlobalDataSet::_typeID
@ _typeID
Definition: dtk_global_data_set.hpp:131
Dtk_SelectionDataSet::Dtk_SelectionDataSet
Dtk_SelectionDataSet(const Dtk_SelectionDataSet &s)
Dtk_FdtDataSet::Clone
virtual Dtk_Object * Clone()
Definition: dtk_global_data_set.hpp:74
Dtk_FdtDataSet::DtkDynamicType
Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
Retrieves the dynamic entity type.
Dtk_FdtDataSet
Definition: dtk_global_data_set.hpp:63
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:686
Dtk_SelectionDataSet::DtkDynamicType
Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
Retrieves the dynamic entity type.
DTK_TYPE_GLOBAL_DATA_SET
@ DTK_TYPE_GLOBAL_DATA_SET
Definition: define.h:445
dtk_fdt_set.hpp
Dtk_FdtDataSet::DtkDynamicCast
static Dtk_FdtDataSet * DtkDynamicCast(Dtk_Object *s)
Performs a dynamic cast - doesn't need RTTI -.
Dtk_SmartPtr
Definition: util_ptr_dtk.hpp:37
Dtk_FdtDataSet::GetNumFdtSets
Dtk_Size_t GetNumFdtSets() const
Retrieves the number of Selection sets.
Dtk_FdtDataSet::Create
static Dtk_FdtDataSetPtr Create()
Calls default constructor to allocate a new object.
util_selection_set.hpp
Dtk_SelectionDataSet::DtkDynamicCast
static Dtk_SelectionDataSet * DtkDynamicCast(Dtk_Object *s)
Performs a dynamic cast - doesn't need RTTI -.
type_detk
type_detk
Definition: define.h:21
Dtk_GlobalDataSet::DtkDynamicCast
static Dtk_GlobalDataSet * DtkDynamicCast(Dtk_Object *s)
Performs a dynamic cast - doesn't need RTTI -.
Dtk_FdtDataSet::AddFdtSet
Dtk_Size_t AddFdtSet(const Dtk_FdtSetPackage::Dtk_FdtSetPtr &inFdtSet)
Adds a Dtk_SelectionSetPtr to the selection sets pool.
Dtk_SelectionDataSet::GetNumSelectionSets
Dtk_Size_t GetNumSelectionSets() const
Retrieves the number of Selection sets.
Dtk_GlobalDataSet::Clone
virtual Dtk_Object * Clone()
Definition: dtk_global_data_set.hpp:126
Dtk_SelectionDataSet::~Dtk_SelectionDataSet
~Dtk_SelectionDataSet()
Destructor.
define.h
Dtk_GlobalDataSet::GetSelectionDataSet
const Dtk_SelectionDataSetPtr GetSelectionDataSet() const
Retrieves the SelectionDataSet.
Dtk_SelectionDataSet::GetSelectionSetByPos
Dtk_SelectionSetPtr GetSelectionSetByPos(const Dtk_Size_t inPos) const
Retrieves the ith Dtk_SelectionSetPtr giving its index.
Dtk_SelectionDataSet::_typeID
@ _typeID
Definition: dtk_global_data_set.hpp:28
Dtk_GlobalDataSet::~Dtk_GlobalDataSet
~Dtk_GlobalDataSet()
Destructor.
Dtk_GlobalDataSet
Definition: dtk_global_data_set.hpp:115
Dtk_GlobalDataSet::GetFdtDataSet
const Dtk_FdtDataSetPtr GetFdtDataSet() const
Retrieves the FdtDataSet.
Dtk_SelectionDataSet::_Private
std::unique_ptr< Dtk_Handle > _Private
Definition: dtk_global_data_set.hpp:15
Dtk_Object
Definition: dtk_object.hpp:8
Dtk_SelectionDataSet
Definition: dtk_global_data_set.hpp:12
Dtk_GlobalDataSet::SetFdtDataSet
void SetFdtDataSet(const Dtk_FdtDataSetPtr &inFdtDataSet)
Set The FdtDataSet infos - for internal use only -.
Dtk_FdtDataSet::_typeID
@ _typeID
Definition: dtk_global_data_set.hpp:79
Dtk_GlobalDataSet::Dtk_GlobalDataSet
Dtk_GlobalDataSet(const Dtk_GlobalDataSet &s)
dtk_object.hpp
Dtk_SelectionDataSet::Clone
virtual Dtk_Object * Clone()
Definition: dtk_global_data_set.hpp:23
Dtk_SelectionDataSet::Dtk_SelectionDataSet
Dtk_SelectionDataSet()