Source/System/FieldContainer/Misc/OSGContainerCollectionBase.cpp

   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 \*---------------------------------------------------------------------------*/
  38
  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 \*****************************************************************************/
  52
  53 #include <cstdlib>
  54 #include <cstdio>
  55
  56 #ifdef WIN32
  57 #pragma warning(disable: 4355) // turn off 'this' : used in base member initializer list warning
  58 #pragma warning(disable: 4290) // disable exception specification warning
  59 #endif
  60
  61 #include "OSGConfig.h"
  62
  63
  64
  65 #include "OSGFieldContainer.h"          // Containers Class
  66
  67 #include "OSGContainerCollectionBase.h"
  68 #include "OSGContainerCollection.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::ContainerCollection
  79
  80  */
  81
  82 /***************************************************************************\
  83  *                        Field Documentation                              *
  84 \***************************************************************************/
  85
  86 /*! \var std::string     ContainerCollectionBase::_sfName
  87     The name of the container collection.  Can be used to identify collections.
  88 */
  89
  90 /*! \var FieldContainer * ContainerCollectionBase::_mfContainers
  91     A list of containers held in the collection.
  92 */
  93
  94
  95 /***************************************************************************\
  96  *                      FieldType/FieldTrait Instantiation                 *
  97 \***************************************************************************/
  98
  99 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 100 PointerType FieldTraits<ContainerCollection *, nsOSG>::_type(
 101     "ContainerCollectionPtr",
 102     "AttachmentPtr",
 103     ContainerCollection::getClassType(),
 104     nsOSG);
 105 #endif
 106
 107 OSG_FIELDTRAITS_GETTYPE_NS(ContainerCollection *, nsOSG)
 108
 109 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 110                            ContainerCollection *,
 111                            nsOSG)
 112
 113 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 114                            ContainerCollection *,
 115                            nsOSG)
 116
 117 /***************************************************************************\
 118  *                         Field Description                               *
 119 \***************************************************************************/
 120
 121 void ContainerCollectionBase::classDescInserter(TypeObject &oType)
 122 {
 123     FieldDescriptionBase *pDesc = NULL;
 124
 125
 126     pDesc = new SFString::Description(
 127         SFString::getClassType(),
 128         "name",
 129         "The name of the container collection.  Can be used to identify collections.\n",
 130         NameFieldId, NameFieldMask,
 131         false,
 132         (Field::SFDefaultFlags | Field::FStdAccess),
 133         static_cast<FieldEditMethodSig>(&ContainerCollection::editHandleName),
 134         static_cast<FieldGetMethodSig >(&ContainerCollection::getHandleName));
 135
 136     oType.addInitialDesc(pDesc);
 137
 138     pDesc = new MFUnrecFieldContainerPtr::Description(
 139         MFUnrecFieldContainerPtr::getClassType(),
 140         "containers",
 141         "A list of containers held in the collection.\n",
 142         ContainersFieldId, ContainersFieldMask,
 143         false,
 144         (Field::MFDefaultFlags | Field::FStdAccess),
 145         static_cast<FieldEditMethodSig>(&ContainerCollection::editHandleContainers),
 146         static_cast<FieldGetMethodSig >(&ContainerCollection::getHandleContainers));
 147
 148     oType.addInitialDesc(pDesc);
 149 }
 150
 151
 152 ContainerCollectionBase::TypeObject ContainerCollectionBase::_type(
 153     ContainerCollectionBase::getClassname(),
 154     Inherited::getClassname(),
 155     "ContainerCollection",
 156     nsOSG, //Namespace
 157     reinterpret_cast<PrototypeCreateF>(&ContainerCollectionBase::createEmptyLocal),
 158     reinterpret_cast<InitContainerF>(&ContainerCollection::initMethod),
 159     reinterpret_cast<ExitContainerF>(&ContainerCollection::exitMethod),
 160     reinterpret_cast<InitalInsertDescFunc>(
 161         reinterpret_cast<void *>(&ContainerCollection::classDescInserter)),
 162     false,
 163     0,
 164     "<?xml version=\"1.0\" ?>\n"
 165     "\n"
 166     "<FieldContainer\n"
 167     "   name=\"ContainerCollection\"\n"
 168     "   parent=\"Attachment\"\n"
 169     "   library=\"System\"\n"
 170     "   structure=\"concrete\"\n"
 171     "   pointerfieldtypes=\"both\"\n"
 172     "   systemcomponent=\"true\"\n"
 173     "   parentsystemcomponent=\"true\"\n"
 174     "   docGroupBase=\"GrpSystemFieldContainer\"\n"
 175     "   >\n"
 176     "  <Field\n"
 177     "\t name=\"name\"\n"
 178     "\t type=\"std::string\"\n"
 179     "\t cardinality=\"single\"\n"
 180     "\t visibility=\"external\"\n"
 181     "\t access=\"public\"\n"
 182     "\t >\n"
 183     "\tThe name of the container collection.  Can be used to identify collections.\n"
 184     "  </Field>\n"
 185     "  <Field\n"
 186     "\t name=\"containers\"\n"
 187     "\t type=\"FieldContainerPtr\"\n"
 188     "\t cardinality=\"multi\"\n"
 189     "\t visibility=\"external\"\n"
 190     "     access=\"public\"\n"
 191     "\t >\n"
 192     "    A list of containers held in the collection.\n"
 193     "  </Field>\n"
 194     "</FieldContainer>\n",
 195     ""
 196     );
 197
 198 /*------------------------------ get -----------------------------------*/
 199
 200 FieldContainerType &ContainerCollectionBase::getType(void)
 201 {
 202     return _type;
 203 }
 204
 205 const FieldContainerType &ContainerCollectionBase::getType(void) const
 206 {
 207     return _type;
 208 }
 209
 210 UInt32 ContainerCollectionBase::getContainerSize(void) const
 211 {
 212     return sizeof(ContainerCollection);
 213 }
 214
 215 /*------------------------- decorator get ------------------------------*/
 216
 217
 218 SFString *ContainerCollectionBase::editSFName(void)
 219 {
 220     editSField(NameFieldMask);
 221
 222     return &_sfName;
 223 }
 224
 225 const SFString *ContainerCollectionBase::getSFName(void) const
 226 {
 227     return &_sfName;
 228 }
 229
 230
 231 //! Get the ContainerCollection::_mfContainers field.
 232 const MFUnrecFieldContainerPtr *ContainerCollectionBase::getMFContainers(void) const
 233 {
 234     return &_mfContainers;
 235 }
 236
 237 MFUnrecFieldContainerPtr *ContainerCollectionBase::editMFContainers     (void)
 238 {
 239     editMField(ContainersFieldMask, _mfContainers);
 240
 241     return &_mfContainers;
 242 }
 243 FieldContainer * ContainerCollectionBase::getContainers(const UInt32 index) const
 244 {
 245     return _mfContainers[index];
 246 }
 247
 248
 249
 250 void ContainerCollectionBase::pushToContainers(FieldContainer * const value)
 251 {
 252     editMField(ContainersFieldMask, _mfContainers);
 253
 254     _mfContainers.push_back(value);
 255 }
 256
 257 void ContainerCollectionBase::assignContainers(const MFUnrecFieldContainerPtr &value)
 258 {
 259     MFUnrecFieldContainerPtr::const_iterator elemIt  =
 260         value.begin();
 261     MFUnrecFieldContainerPtr::const_iterator elemEnd =
 262         value.end  ();
 263
 264     static_cast<ContainerCollection *>(this)->clearContainers();
 265
 266     while(elemIt != elemEnd)
 267     {
 268         this->pushToContainers(*elemIt);
 269
 270         ++elemIt;
 271     }
 272 }
 273
 274 void ContainerCollectionBase::removeFromContainers(UInt32 uiIndex)
 275 {
 276     if(uiIndex < _mfContainers.size())
 277     {
 278         editMField(ContainersFieldMask, _mfContainers);
 279
 280         _mfContainers.erase(uiIndex);
 281     }
 282 }
 283
 284 void ContainerCollectionBase::removeObjFromContainers(FieldContainer * const value)
 285 {
 286     Int32 iElemIdx = _mfContainers.findIndex(value);
 287
 288     if(iElemIdx != -1)
 289     {
 290         editMField(ContainersFieldMask, _mfContainers);
 291
 292         _mfContainers.erase(iElemIdx);
 293     }
 294 }
 295 void ContainerCollectionBase::clearContainers(void)
 296 {
 297     editMField(ContainersFieldMask, _mfContainers);
 298
 299
 300     _mfContainers.clear();
 301 }
 302
 303
 304
 305 /*------------------------------ access -----------------------------------*/
 306
 307 SizeT ContainerCollectionBase::getBinSize(ConstFieldMaskArg whichField)
 308 {
 309     SizeT returnValue = Inherited::getBinSize(whichField);
 310
 311     if(FieldBits::NoField != (NameFieldMask & whichField))
 312     {
 313         returnValue += _sfName.getBinSize();
 314     }
 315     if(FieldBits::NoField != (ContainersFieldMask & whichField))
 316     {
 317         returnValue += _mfContainers.getBinSize();
 318     }
 319
 320     return returnValue;
 321 }
 322
 323 void ContainerCollectionBase::copyToBin(BinaryDataHandler &pMem,
 324                                   ConstFieldMaskArg  whichField)
 325 {
 326     Inherited::copyToBin(pMem, whichField);
 327
 328     if(FieldBits::NoField != (NameFieldMask & whichField))
 329     {
 330         _sfName.copyToBin(pMem);
 331     }
 332     if(FieldBits::NoField != (ContainersFieldMask & whichField))
 333     {
 334         _mfContainers.copyToBin(pMem);
 335     }
 336 }
 337
 338 void ContainerCollectionBase::copyFromBin(BinaryDataHandler &pMem,
 339                                     ConstFieldMaskArg  whichField)
 340 {
 341     Inherited::copyFromBin(pMem, whichField);
 342
 343     if(FieldBits::NoField != (NameFieldMask & whichField))
 344     {
 345         editSField(NameFieldMask);
 346         _sfName.copyFromBin(pMem);
 347     }
 348     if(FieldBits::NoField != (ContainersFieldMask & whichField))
 349     {
 350         editMField(ContainersFieldMask, _mfContainers);
 351         _mfContainers.copyFromBin(pMem);
 352     }
 353 }
 354
 355 //! create a new instance of the class
 356 ContainerCollectionTransitPtr ContainerCollectionBase::createLocal(BitVector bFlags)
 357 {
 358     ContainerCollectionTransitPtr fc;
 359
 360     if(getClassType().getPrototype() != NULL)
 361     {
 362         FieldContainerTransitPtr tmpPtr =
 363             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 364
 365         fc = dynamic_pointer_cast<ContainerCollection>(tmpPtr);
 366     }
 367
 368     return fc;
 369 }
 370
 371 //! create a new instance of the class, copy the container flags
 372 ContainerCollectionTransitPtr ContainerCollectionBase::createDependent(BitVector bFlags)
 373 {
 374     ContainerCollectionTransitPtr fc;
 375
 376     if(getClassType().getPrototype() != NULL)
 377     {
 378         FieldContainerTransitPtr tmpPtr =
 379             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 380
 381         fc = dynamic_pointer_cast<ContainerCollection>(tmpPtr);
 382     }
 383
 384     return fc;
 385 }
 386
 387 //! create a new instance of the class
 388 ContainerCollectionTransitPtr ContainerCollectionBase::create(void)
 389 {
 390     ContainerCollectionTransitPtr fc;
 391
 392     if(getClassType().getPrototype() != NULL)
 393     {
 394         FieldContainerTransitPtr tmpPtr =
 395             getClassType().getPrototype()-> shallowCopy();
 396
 397         fc = dynamic_pointer_cast<ContainerCollection>(tmpPtr);
 398     }
 399
 400     return fc;
 401 }
 402
 403 ContainerCollection *ContainerCollectionBase::createEmptyLocal(BitVector bFlags)
 404 {
 405     ContainerCollection *returnValue;
 406
 407     newPtr<ContainerCollection>(returnValue, bFlags);
 408
 409     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 410
 411     return returnValue;
 412 }
 413
 414 //! create an empty new instance of the class, do not copy the prototype
 415 ContainerCollection *ContainerCollectionBase::createEmpty(void)
 416 {
 417     ContainerCollection *returnValue;
 418
 419     newPtr<ContainerCollection>(returnValue, Thread::getCurrentLocalFlags());
 420
 421     returnValue->_pFieldFlags->_bNamespaceMask &=
 422         ~Thread::getCurrentLocalFlags();
 423
 424     return returnValue;
 425 }
 426
 427
 428 FieldContainerTransitPtr ContainerCollectionBase::shallowCopyLocal(
 429     BitVector bFlags) const
 430 {
 431     ContainerCollection *tmpPtr;
 432
 433     newPtr(tmpPtr, dynamic_cast<const ContainerCollection *>(this), bFlags);
 434
 435     FieldContainerTransitPtr returnValue(tmpPtr);
 436
 437     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 438
 439     return returnValue;
 440 }
 441
 442 FieldContainerTransitPtr ContainerCollectionBase::shallowCopyDependent(
 443     BitVector bFlags) const
 444 {
 445     ContainerCollection *tmpPtr;
 446
 447     newPtr(tmpPtr, dynamic_cast<const ContainerCollection *>(this), ~bFlags);
 448
 449     FieldContainerTransitPtr returnValue(tmpPtr);
 450
 451     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 452
 453     return returnValue;
 454 }
 455
 456 FieldContainerTransitPtr ContainerCollectionBase::shallowCopy(void) const
 457 {
 458     ContainerCollection *tmpPtr;
 459
 460     newPtr(tmpPtr,
 461            dynamic_cast<const ContainerCollection *>(this),
 462            Thread::getCurrentLocalFlags());
 463
 464     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 465
 466     FieldContainerTransitPtr returnValue(tmpPtr);
 467
 468     return returnValue;
 469 }
 470
 471
 472
 473
 474 /*------------------------- constructors ----------------------------------*/
 475
 476 ContainerCollectionBase::ContainerCollectionBase(void) :
 477     Inherited(),
 478     _sfName                   (),
 479     _mfContainers             ()
 480 {
 481 }
 482
 483 ContainerCollectionBase::ContainerCollectionBase(const ContainerCollectionBase &source) :
 484     Inherited(source),
 485     _sfName                   (source._sfName                   ),
 486     _mfContainers             ()
 487 {
 488 }
 489
 490
 491 /*-------------------------- destructors ----------------------------------*/
 492
 493 ContainerCollectionBase::~ContainerCollectionBase(void)
 494 {
 495 }
 496
 497 void ContainerCollectionBase::onCreate(const ContainerCollection *source)
 498 {
 499     Inherited::onCreate(source);
 500
 501     if(source != NULL)
 502     {
 503         ContainerCollection *pThis = static_cast<ContainerCollection *>(this);
 504
 505         MFUnrecFieldContainerPtr::const_iterator ContainersIt  =
 506             source->_mfContainers.begin();
 507         MFUnrecFieldContainerPtr::const_iterator ContainersEnd =
 508             source->_mfContainers.end  ();
 509
 510         while(ContainersIt != ContainersEnd)
 511         {
 512             pThis->pushToContainers(*ContainersIt);
 513
 514             ++ContainersIt;
 515         }
 516     }
 517 }
 518
 519 GetFieldHandlePtr ContainerCollectionBase::getHandleName            (void) const
 520 {
 521     SFString::GetHandlePtr returnValue(
 522         new  SFString::GetHandle(
 523              &_sfName,
 524              this->getType().getFieldDesc(NameFieldId),
 525              const_cast<ContainerCollectionBase *>(this)));
 526
 527     return returnValue;
 528 }
 529
 530 EditFieldHandlePtr ContainerCollectionBase::editHandleName           (void)
 531 {
 532     SFString::EditHandlePtr returnValue(
 533         new  SFString::EditHandle(
 534              &_sfName,
 535              this->getType().getFieldDesc(NameFieldId),
 536              this));
 537
 538
 539     editSField(NameFieldMask);
 540
 541     return returnValue;
 542 }
 543
 544 GetFieldHandlePtr ContainerCollectionBase::getHandleContainers      (void) const
 545 {
 546     MFUnrecFieldContainerPtr::GetHandlePtr returnValue(
 547         new  MFUnrecFieldContainerPtr::GetHandle(
 548              &_mfContainers,
 549              this->getType().getFieldDesc(ContainersFieldId),
 550              const_cast<ContainerCollectionBase *>(this)));
 551
 552     return returnValue;
 553 }
 554
 555 EditFieldHandlePtr ContainerCollectionBase::editHandleContainers     (void)
 556 {
 557     MFUnrecFieldContainerPtr::EditHandlePtr returnValue(
 558         new  MFUnrecFieldContainerPtr::EditHandle(
 559              &_mfContainers,
 560              this->getType().getFieldDesc(ContainersFieldId),
 561              this));
 562
 563     returnValue->setAddMethod(
 564         boost::bind(&ContainerCollection::pushToContainers,
 565                     static_cast<ContainerCollection *>(this), _1));
 566     returnValue->setRemoveMethod(
 567         boost::bind(&ContainerCollection::removeFromContainers,
 568                     static_cast<ContainerCollection *>(this), _1));
 569     returnValue->setRemoveObjMethod(
 570         boost::bind(&ContainerCollection::removeObjFromContainers,
 571                     static_cast<ContainerCollection *>(this), _1));
 572     returnValue->setClearMethod(
 573         boost::bind(&ContainerCollection::clearContainers,
 574                     static_cast<ContainerCollection *>(this)));
 575
 576     editMField(ContainersFieldMask, _mfContainers);
 577
 578     return returnValue;
 579 }
 580
 581
 582 #ifdef OSG_MT_CPTR_ASPECT
 583 void ContainerCollectionBase::execSyncV(      FieldContainer    &oFrom,
 584                                         ConstFieldMaskArg  whichField,
 585                                         AspectOffsetStore &oOffsets,
 586                                         ConstFieldMaskArg  syncMode,
 587                                   const UInt32             uiSyncInfo)
 588 {
 589     ContainerCollection *pThis = static_cast<ContainerCollection *>(this);
 590
 591     pThis->execSync(static_cast<ContainerCollection *>(&oFrom),
 592                     whichField,
 593                     oOffsets,
 594                     syncMode,
 595                     uiSyncInfo);
 596 }
 597 #endif
 598
 599
 600 #ifdef OSG_MT_CPTR_ASPECT
 601 FieldContainer *ContainerCollectionBase::createAspectCopy(
 602     const FieldContainer *pRefAspect) const
 603 {
 604     ContainerCollection *returnValue;
 605
 606     newAspectCopy(returnValue,
 607                   dynamic_cast<const ContainerCollection *>(pRefAspect),
 608                   dynamic_cast<const ContainerCollection *>(this));
 609
 610     return returnValue;
 611 }
 612 #endif
 613
 614 void ContainerCollectionBase::resolveLinks(void)
 615 {
 616     Inherited::resolveLinks();
 617
 618     static_cast<ContainerCollection *>(this)->clearContainers();
 619
 620
 621 }
 622
 623
 624 OSG_END_NAMESPACE