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