changed: gcc8 base update
[opensg.git] / Source / System / FieldContainer / Misc / OSGContainerCollectionBase.h
blobfe0bea7218fad01bbfc489a2c3e5b87c7bec9c69
1 /*---------------------------------------------------------------------------*\
2 * OpenSG *
3 * *
4 * *
5 * Copyright (C) 2000-2013 by the OpenSG Forum *
6 * *
7 * www.opensg.org *
8 * *
9 * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net *
10 * *
11 \*---------------------------------------------------------------------------*/
12 /*---------------------------------------------------------------------------*\
13 * License *
14 * *
15 * This library is free software; you can redistribute it and/or modify it *
16 * under the terms of the GNU Library General Public License as published *
17 * by the Free Software Foundation, version 2. *
18 * *
19 * This library is distributed in the hope that it will be useful, but *
20 * WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
22 * Library General Public License for more details. *
23 * *
24 * You should have received a copy of the GNU Library General Public *
25 * License along with this library; if not, write to the Free Software *
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
27 * *
28 \*---------------------------------------------------------------------------*/
29 /*---------------------------------------------------------------------------*\
30 * Changes *
31 * *
32 * *
33 * *
34 * *
35 * *
36 * *
37 \*---------------------------------------------------------------------------*/
39 /*****************************************************************************\
40 *****************************************************************************
41 ** **
42 ** This file is automatically generated. **
43 ** **
44 ** Any changes made to this file WILL be lost when it is **
45 ** regenerated, which can become necessary at any time. **
46 ** **
47 ** Do not change this file, changes should be done in the derived **
48 ** class ContainerCollection
49 ** **
50 *****************************************************************************
51 \*****************************************************************************/
54 #ifndef _OSGCONTAINERCOLLECTIONBASE_H_
55 #define _OSGCONTAINERCOLLECTIONBASE_H_
56 #ifdef __sgi
57 #pragma once
58 #endif
61 #include "OSGConfig.h"
62 #include "OSGSystemDef.h"
64 //#include "OSGBaseTypes.h"
66 #include "OSGAttachment.h" // Parent
68 #include "OSGBaseFields.h" // Name type
69 #include "OSGFieldContainerFields.h" // Containers type
71 #include "OSGContainerCollectionFields.h"
73 OSG_BEGIN_NAMESPACE
76 class ContainerCollection;
78 //! \brief ContainerCollection Base Class.
80 class OSG_SYSTEM_DLLMAPPING ContainerCollectionBase : public Attachment
82 public:
84 typedef Attachment Inherited;
85 typedef Attachment ParentContainer;
87 typedef Inherited::TypeObject TypeObject;
88 typedef TypeObject::InitPhase InitPhase;
90 OSG_GEN_INTERNALPTR(ContainerCollection);
92 /*========================== PUBLIC =================================*/
94 public:
96 enum
98 NameFieldId = Inherited::NextFieldId,
99 ContainersFieldId = NameFieldId + 1,
100 NextFieldId = ContainersFieldId + 1
103 static const OSG::BitVector NameFieldMask =
104 (TypeTraits<BitVector>::One << NameFieldId);
105 static const OSG::BitVector ContainersFieldMask =
106 (TypeTraits<BitVector>::One << ContainersFieldId);
107 static const OSG::BitVector NextFieldMask =
108 (TypeTraits<BitVector>::One << NextFieldId);
110 typedef SFString SFNameType;
111 typedef MFUnrecFieldContainerPtr MFContainersType;
113 /*---------------------------------------------------------------------*/
114 /*! \name Class Get */
115 /*! \{ */
117 static FieldContainerType &getClassType (void);
118 static UInt32 getClassTypeId (void);
119 static UInt16 getClassGroupId(void);
121 /*! \} */
122 /*---------------------------------------------------------------------*/
123 /*! \name FieldContainer Get */
124 /*! \{ */
126 virtual FieldContainerType &getType (void);
127 virtual const FieldContainerType &getType (void) const;
129 virtual UInt32 getContainerSize(void) const;
131 /*! \} */
132 /*---------------------------------------------------------------------*/
133 /*! \name Field Get */
134 /*! \{ */
137 SFString *editSFName (void);
138 const SFString *getSFName (void) const;
139 const MFUnrecFieldContainerPtr *getMFContainers (void) const;
140 MFUnrecFieldContainerPtr *editMFContainers (void);
143 std::string &editName (void);
144 const std::string &getName (void) const;
146 FieldContainer * getContainers (const UInt32 index) const;
148 /*! \} */
149 /*---------------------------------------------------------------------*/
150 /*! \name Field Set */
151 /*! \{ */
153 void setName (const std::string &value);
155 /*! \} */
156 /*---------------------------------------------------------------------*/
157 /*! \name Ptr Field Set */
158 /*! \{ */
160 /*! \} */
161 /*---------------------------------------------------------------------*/
162 /*! \name Ptr MField Set */
163 /*! \{ */
165 void pushToContainers (FieldContainer * const value );
166 void assignContainers (const MFUnrecFieldContainerPtr &value);
167 void removeFromContainers (UInt32 uiIndex );
168 void removeObjFromContainers(FieldContainer * const value );
169 void clearContainers (void );
171 /*! \} */
172 /*---------------------------------------------------------------------*/
173 /*! \name Binary Access */
174 /*! \{ */
176 virtual SizeT getBinSize (ConstFieldMaskArg whichField);
177 virtual void copyToBin (BinaryDataHandler &pMem,
178 ConstFieldMaskArg whichField);
179 virtual void copyFromBin(BinaryDataHandler &pMem,
180 ConstFieldMaskArg whichField);
183 /*! \} */
184 /*---------------------------------------------------------------------*/
185 /*! \name Construction */
186 /*! \{ */
188 static ContainerCollectionTransitPtr create (void);
189 static ContainerCollection *createEmpty (void);
191 static ContainerCollectionTransitPtr createLocal (
192 BitVector bFlags = FCLocal::All);
194 static ContainerCollection *createEmptyLocal(
195 BitVector bFlags = FCLocal::All);
197 static ContainerCollectionTransitPtr createDependent (BitVector bFlags);
199 /*! \} */
200 /*---------------------------------------------------------------------*/
201 /*! \name Copy */
202 /*! \{ */
204 virtual FieldContainerTransitPtr shallowCopy (void) const;
205 virtual FieldContainerTransitPtr shallowCopyLocal(
206 BitVector bFlags = FCLocal::All) const;
207 virtual FieldContainerTransitPtr shallowCopyDependent(
208 BitVector bFlags) const;
210 /*! \} */
211 /*========================= PROTECTED ===============================*/
213 protected:
215 static TypeObject _type;
217 static void classDescInserter(TypeObject &oType);
218 static const Char8 *getClassname (void );
220 /*---------------------------------------------------------------------*/
221 /*! \name Fields */
222 /*! \{ */
224 SFString _sfName;
225 MFUnrecFieldContainerPtr _mfContainers;
227 /*! \} */
228 /*---------------------------------------------------------------------*/
229 /*! \name Constructors */
230 /*! \{ */
232 ContainerCollectionBase(void);
233 ContainerCollectionBase(const ContainerCollectionBase &source);
235 /*! \} */
236 /*---------------------------------------------------------------------*/
237 /*! \name Destructors */
238 /*! \{ */
240 virtual ~ContainerCollectionBase(void);
242 /*! \} */
243 /*---------------------------------------------------------------------*/
244 /*! \name onCreate */
245 /*! \{ */
247 void onCreate(const ContainerCollection *source = NULL);
249 /*! \} */
250 /*---------------------------------------------------------------------*/
251 /*! \name Generic Field Access */
252 /*! \{ */
254 GetFieldHandlePtr getHandleName (void) const;
255 EditFieldHandlePtr editHandleName (void);
256 GetFieldHandlePtr getHandleContainers (void) const;
257 EditFieldHandlePtr editHandleContainers (void);
259 /*! \} */
260 /*---------------------------------------------------------------------*/
261 /*! \name Sync */
262 /*! \{ */
264 #ifdef OSG_MT_CPTR_ASPECT
265 virtual void execSyncV( FieldContainer &oFrom,
266 ConstFieldMaskArg whichField,
267 AspectOffsetStore &oOffsets,
268 ConstFieldMaskArg syncMode ,
269 const UInt32 uiSyncInfo);
271 void execSync ( ContainerCollectionBase *pFrom,
272 ConstFieldMaskArg whichField,
273 AspectOffsetStore &oOffsets,
274 ConstFieldMaskArg syncMode ,
275 const UInt32 uiSyncInfo);
276 #endif
278 /*! \} */
279 /*---------------------------------------------------------------------*/
280 /*! \name Edit */
281 /*! \{ */
283 /*! \} */
284 /*---------------------------------------------------------------------*/
285 /*! \name Aspect Create */
286 /*! \{ */
288 #ifdef OSG_MT_CPTR_ASPECT
289 virtual FieldContainer *createAspectCopy(
290 const FieldContainer *pRefAspect) const;
291 #endif
293 /*! \} */
294 /*---------------------------------------------------------------------*/
295 /*! \name Edit */
296 /*! \{ */
297 /*! \} */
298 /*---------------------------------------------------------------------*/
299 /*! \name Sync */
300 /*! \{ */
302 virtual void resolveLinks(void);
304 /*! \} */
305 /*========================== PRIVATE ================================*/
307 private:
308 /*---------------------------------------------------------------------*/
310 // prohibit default functions (move to 'public' if you need one)
311 void operator =(const ContainerCollectionBase &source);
314 typedef ContainerCollectionBase *ContainerCollectionBaseP;
316 OSG_END_NAMESPACE
318 #endif /* _OSGCONTAINERCOLLECTIONBASE_H_ */