Source/System/FieldContainer/Attachments/OSGStringAttributeMapBase.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 StringAttributeMap!
  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
  66 #include "OSGStringAttributeMapBase.h"
  67 #include "OSGStringAttributeMap.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::StringAttributeMap
  78     An attachment that stores a string-to-string mapping of keys to values.
  79     User code can store any key and value pair and interpret the string value in
  80     whatever ways are appropriate.
  81  */
  82
  83 /***************************************************************************\
  84  *                        Field Documentation                              *
  85 \***************************************************************************/
  86
  87 /*! \var std::string     StringAttributeMapBase::_mfKeys
  88
  89 */
  90
  91 /*! \var std::string     StringAttributeMapBase::_mfValues
  92
  93 */
  94
  95
  96 /***************************************************************************\
  97  *                      FieldType/FieldTrait Instantiation                 *
  98 \***************************************************************************/
  99
 100 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 101 PointerType FieldTraits<StringAttributeMap *, nsOSG>::_type(
 102     "StringAttributeMapPtr",
 103     "AttachmentPtr",
 104     StringAttributeMap::getClassType(),
 105     nsOSG);
 106 #endif
 107
 108 OSG_FIELDTRAITS_GETTYPE_NS(StringAttributeMap *, nsOSG)
 109
 110 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 111                            StringAttributeMap *,
 112                            nsOSG)
 113
 114
 115 /***************************************************************************\
 116  *                         Field Description                               *
 117 \***************************************************************************/
 118
 119 void StringAttributeMapBase::classDescInserter(TypeObject &oType)
 120 {
 121     FieldDescriptionBase *pDesc = NULL;
 122
 123
 124     pDesc = new MFString::Description(
 125         MFString::getClassType(),
 126         "keys",
 127         "",
 128         KeysFieldId, KeysFieldMask,
 129         false,
 130         (Field::MFDefaultFlags | Field::FStdAccess),
 131         static_cast<FieldEditMethodSig>(&StringAttributeMap::editHandleKeys),
 132         static_cast<FieldGetMethodSig >(&StringAttributeMap::getHandleKeys));
 133
 134     oType.addInitialDesc(pDesc);
 135
 136     pDesc = new MFString::Description(
 137         MFString::getClassType(),
 138         "values",
 139         "",
 140         ValuesFieldId, ValuesFieldMask,
 141         false,
 142         (Field::MFDefaultFlags | Field::FStdAccess),
 143         static_cast<FieldEditMethodSig>(&StringAttributeMap::editHandleValues),
 144         static_cast<FieldGetMethodSig >(&StringAttributeMap::getHandleValues));
 145
 146     oType.addInitialDesc(pDesc);
 147 }
 148
 149
 150 StringAttributeMapBase::TypeObject StringAttributeMapBase::_type(
 151     StringAttributeMapBase::getClassname(),
 152     Inherited::getClassname(),
 153     "StringAttributeMap",
 154     nsOSG, //Namespace
 155     reinterpret_cast<PrototypeCreateF>(&StringAttributeMapBase::createEmptyLocal),
 156     reinterpret_cast<InitContainerF>(&StringAttributeMap::initMethod),
 157     reinterpret_cast<ExitContainerF>(&StringAttributeMap::exitMethod),
 158     reinterpret_cast<InitalInsertDescFunc>(
 159         reinterpret_cast<void *>(&StringAttributeMap::classDescInserter)),
 160     false,
 161     0,
 162     "<?xml version=\"1.0\"?>\n"
 163     "\n"
 164     "<FieldContainer\n"
 165     "   name=\"StringAttributeMap\"\n"
 166     "   parent=\"Attachment\"\n"
 167     "   library=\"System\"\n"
 168     "   pointerfieldtypes=\"single\"\n"
 169     "   structure=\"concrete\"\n"
 170     "   systemcomponent=\"true\"\n"
 171     "   parentsystemcomponent=\"true\"\n"
 172     "   decoratable=\"false\"\n"
 173     "   useLocalIncludes=\"false\"\n"
 174     "   docGroupBase=\"GrpSystemFieldContainer\"\n"
 175     "   >\n"
 176     "  An attachment that stores a string-to-string mapping of keys to values.\n"
 177     "  User code can store any key and value pair and interpret the string value in\n"
 178     "  whatever ways are appropriate.\n"
 179     "  <Field\n"
 180     "\t name=\"keys\"\n"
 181     "\t type=\"std::string\"\n"
 182     "\t cardinality=\"multi\"\n"
 183     "\t visibility=\"external\"\n"
 184     "\t access=\"protected\"\n"
 185     "\t >\n"
 186     "  </Field>\n"
 187     "  <Field\n"
 188     "\t name=\"values\"\n"
 189     "\t type=\"std::string\"\n"
 190     "\t cardinality=\"multi\"\n"
 191     "\t visibility=\"external\"\n"
 192     "\t access=\"protected\"\n"
 193     "\t >\n"
 194     "  </Field>\n"
 195     "</FieldContainer>\n",
 196     "An attachment that stores a string-to-string mapping of keys to values.\n"
 197     "User code can store any key and value pair and interpret the string value in\n"
 198     "whatever ways are appropriate.\n"
 199     );
 200
 201 /*------------------------------ get -----------------------------------*/
 202
 203 FieldContainerType &StringAttributeMapBase::getType(void)
 204 {
 205     return _type;
 206 }
 207
 208 const FieldContainerType &StringAttributeMapBase::getType(void) const
 209 {
 210     return _type;
 211 }
 212
 213 UInt32 StringAttributeMapBase::getContainerSize(void) const
 214 {
 215     return sizeof(StringAttributeMap);
 216 }
 217
 218 /*------------------------- decorator get ------------------------------*/
 219
 220
 221 MFString *StringAttributeMapBase::editMFKeys(void)
 222 {
 223     editMField(KeysFieldMask, _mfKeys);
 224
 225     return &_mfKeys;
 226 }
 227
 228 const MFString *StringAttributeMapBase::getMFKeys(void) const
 229 {
 230     return &_mfKeys;
 231 }
 232
 233
 234 MFString *StringAttributeMapBase::editMFValues(void)
 235 {
 236     editMField(ValuesFieldMask, _mfValues);
 237
 238     return &_mfValues;
 239 }
 240
 241 const MFString *StringAttributeMapBase::getMFValues(void) const
 242 {
 243     return &_mfValues;
 244 }
 245
 246
 247
 248
 249
 250
 251 /*------------------------------ access -----------------------------------*/
 252
 253 SizeT StringAttributeMapBase::getBinSize(ConstFieldMaskArg whichField)
 254 {
 255     SizeT returnValue = Inherited::getBinSize(whichField);
 256
 257     if(FieldBits::NoField != (KeysFieldMask & whichField))
 258     {
 259         returnValue += _mfKeys.getBinSize();
 260     }
 261     if(FieldBits::NoField != (ValuesFieldMask & whichField))
 262     {
 263         returnValue += _mfValues.getBinSize();
 264     }
 265
 266     return returnValue;
 267 }
 268
 269 void StringAttributeMapBase::copyToBin(BinaryDataHandler &pMem,
 270                                   ConstFieldMaskArg  whichField)
 271 {
 272     Inherited::copyToBin(pMem, whichField);
 273
 274     if(FieldBits::NoField != (KeysFieldMask & whichField))
 275     {
 276         _mfKeys.copyToBin(pMem);
 277     }
 278     if(FieldBits::NoField != (ValuesFieldMask & whichField))
 279     {
 280         _mfValues.copyToBin(pMem);
 281     }
 282 }
 283
 284 void StringAttributeMapBase::copyFromBin(BinaryDataHandler &pMem,
 285                                     ConstFieldMaskArg  whichField)
 286 {
 287     Inherited::copyFromBin(pMem, whichField);
 288
 289     if(FieldBits::NoField != (KeysFieldMask & whichField))
 290     {
 291         editMField(KeysFieldMask, _mfKeys);
 292         _mfKeys.copyFromBin(pMem);
 293     }
 294     if(FieldBits::NoField != (ValuesFieldMask & whichField))
 295     {
 296         editMField(ValuesFieldMask, _mfValues);
 297         _mfValues.copyFromBin(pMem);
 298     }
 299 }
 300
 301 //! create a new instance of the class
 302 StringAttributeMapTransitPtr StringAttributeMapBase::createLocal(BitVector bFlags)
 303 {
 304     StringAttributeMapTransitPtr fc;
 305
 306     if(getClassType().getPrototype() != NULL)
 307     {
 308         FieldContainerTransitPtr tmpPtr =
 309             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 310
 311         fc = dynamic_pointer_cast<StringAttributeMap>(tmpPtr);
 312     }
 313
 314     return fc;
 315 }
 316
 317 //! create a new instance of the class, copy the container flags
 318 StringAttributeMapTransitPtr StringAttributeMapBase::createDependent(BitVector bFlags)
 319 {
 320     StringAttributeMapTransitPtr fc;
 321
 322     if(getClassType().getPrototype() != NULL)
 323     {
 324         FieldContainerTransitPtr tmpPtr =
 325             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 326
 327         fc = dynamic_pointer_cast<StringAttributeMap>(tmpPtr);
 328     }
 329
 330     return fc;
 331 }
 332
 333 //! create a new instance of the class
 334 StringAttributeMapTransitPtr StringAttributeMapBase::create(void)
 335 {
 336     StringAttributeMapTransitPtr fc;
 337
 338     if(getClassType().getPrototype() != NULL)
 339     {
 340         FieldContainerTransitPtr tmpPtr =
 341             getClassType().getPrototype()-> shallowCopy();
 342
 343         fc = dynamic_pointer_cast<StringAttributeMap>(tmpPtr);
 344     }
 345
 346     return fc;
 347 }
 348
 349 StringAttributeMap *StringAttributeMapBase::createEmptyLocal(BitVector bFlags)
 350 {
 351     StringAttributeMap *returnValue;
 352
 353     newPtr<StringAttributeMap>(returnValue, bFlags);
 354
 355     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 356
 357     return returnValue;
 358 }
 359
 360 //! create an empty new instance of the class, do not copy the prototype
 361 StringAttributeMap *StringAttributeMapBase::createEmpty(void)
 362 {
 363     StringAttributeMap *returnValue;
 364
 365     newPtr<StringAttributeMap>(returnValue, Thread::getCurrentLocalFlags());
 366
 367     returnValue->_pFieldFlags->_bNamespaceMask &=
 368         ~Thread::getCurrentLocalFlags();
 369
 370     return returnValue;
 371 }
 372
 373
 374 FieldContainerTransitPtr StringAttributeMapBase::shallowCopyLocal(
 375     BitVector bFlags) const
 376 {
 377     StringAttributeMap *tmpPtr;
 378
 379     newPtr(tmpPtr, dynamic_cast<const StringAttributeMap *>(this), bFlags);
 380
 381     FieldContainerTransitPtr returnValue(tmpPtr);
 382
 383     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 384
 385     return returnValue;
 386 }
 387
 388 FieldContainerTransitPtr StringAttributeMapBase::shallowCopyDependent(
 389     BitVector bFlags) const
 390 {
 391     StringAttributeMap *tmpPtr;
 392
 393     newPtr(tmpPtr, dynamic_cast<const StringAttributeMap *>(this), ~bFlags);
 394
 395     FieldContainerTransitPtr returnValue(tmpPtr);
 396
 397     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 398
 399     return returnValue;
 400 }
 401
 402 FieldContainerTransitPtr StringAttributeMapBase::shallowCopy(void) const
 403 {
 404     StringAttributeMap *tmpPtr;
 405
 406     newPtr(tmpPtr,
 407            dynamic_cast<const StringAttributeMap *>(this),
 408            Thread::getCurrentLocalFlags());
 409
 410     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 411
 412     FieldContainerTransitPtr returnValue(tmpPtr);
 413
 414     return returnValue;
 415 }
 416
 417
 418
 419
 420 /*------------------------- constructors ----------------------------------*/
 421
 422 StringAttributeMapBase::StringAttributeMapBase(void) :
 423     Inherited(),
 424     _mfKeys                   (),
 425     _mfValues                 ()
 426 {
 427 }
 428
 429 StringAttributeMapBase::StringAttributeMapBase(const StringAttributeMapBase &source) :
 430     Inherited(source),
 431     _mfKeys                   (source._mfKeys                   ),
 432     _mfValues                 (source._mfValues                 )
 433 {
 434 }
 435
 436
 437 /*-------------------------- destructors ----------------------------------*/
 438
 439 StringAttributeMapBase::~StringAttributeMapBase(void)
 440 {
 441 }
 442
 443
 444 GetFieldHandlePtr StringAttributeMapBase::getHandleKeys            (void) const
 445 {
 446     MFString::GetHandlePtr returnValue(
 447         new  MFString::GetHandle(
 448              &_mfKeys,
 449              this->getType().getFieldDesc(KeysFieldId),
 450              const_cast<StringAttributeMapBase *>(this)));
 451
 452     return returnValue;
 453 }
 454
 455 EditFieldHandlePtr StringAttributeMapBase::editHandleKeys           (void)
 456 {
 457     MFString::EditHandlePtr returnValue(
 458         new  MFString::EditHandle(
 459              &_mfKeys,
 460              this->getType().getFieldDesc(KeysFieldId),
 461              this));
 462
 463
 464     editMField(KeysFieldMask, _mfKeys);
 465
 466     return returnValue;
 467 }
 468
 469 GetFieldHandlePtr StringAttributeMapBase::getHandleValues          (void) const
 470 {
 471     MFString::GetHandlePtr returnValue(
 472         new  MFString::GetHandle(
 473              &_mfValues,
 474              this->getType().getFieldDesc(ValuesFieldId),
 475              const_cast<StringAttributeMapBase *>(this)));
 476
 477     return returnValue;
 478 }
 479
 480 EditFieldHandlePtr StringAttributeMapBase::editHandleValues         (void)
 481 {
 482     MFString::EditHandlePtr returnValue(
 483         new  MFString::EditHandle(
 484              &_mfValues,
 485              this->getType().getFieldDesc(ValuesFieldId),
 486              this));
 487
 488
 489     editMField(ValuesFieldMask, _mfValues);
 490
 491     return returnValue;
 492 }
 493
 494
 495 #ifdef OSG_MT_CPTR_ASPECT
 496 void StringAttributeMapBase::execSyncV(      FieldContainer    &oFrom,
 497                                         ConstFieldMaskArg  whichField,
 498                                         AspectOffsetStore &oOffsets,
 499                                         ConstFieldMaskArg  syncMode,
 500                                   const UInt32             uiSyncInfo)
 501 {
 502     StringAttributeMap *pThis = static_cast<StringAttributeMap *>(this);
 503
 504     pThis->execSync(static_cast<StringAttributeMap *>(&oFrom),
 505                     whichField,
 506                     oOffsets,
 507                     syncMode,
 508                     uiSyncInfo);
 509 }
 510 #endif
 511
 512
 513 #ifdef OSG_MT_CPTR_ASPECT
 514 FieldContainer *StringAttributeMapBase::createAspectCopy(
 515     const FieldContainer *pRefAspect) const
 516 {
 517     StringAttributeMap *returnValue;
 518
 519     newAspectCopy(returnValue,
 520                   dynamic_cast<const StringAttributeMap *>(pRefAspect),
 521                   dynamic_cast<const StringAttributeMap *>(this));
 522
 523     return returnValue;
 524 }
 525 #endif
 526
 527 void StringAttributeMapBase::resolveLinks(void)
 528 {
 529     Inherited::resolveLinks();
 530
 531 #ifdef OSG_MT_CPTR_ASPECT
 532     AspectOffsetStore oOffsets;
 533
 534     _pAspectStore->fillOffsetArray(oOffsets, this);
 535 #endif
 536
 537 #ifdef OSG_MT_CPTR_ASPECT
 538     _mfKeys.terminateShare(Thread::getCurrentAspect(),
 539                                       oOffsets);
 540 #endif
 541 #ifdef OSG_MT_CPTR_ASPECT
 542     _mfValues.terminateShare(Thread::getCurrentAspect(),
 543                                       oOffsets);
 544 #endif
 545 }
 546
 547
 548 OSG_END_NAMESPACE