src/SALOMEDSImpl/SALOMEDSImpl_UseCaseBuilder.cxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOMEDSImpl_UseCaseBuilder.cxx
  24 //  Author : Sergey RUIN
  25 //  Module : SALOME
  26
  27 #include "SALOMEDSImpl_UseCaseBuilder.hxx"
  28 #include "SALOMEDSImpl_SObject.hxx"
  29 #include "SALOMEDSImpl_SComponent.hxx"
  30 #include "SALOMEDSImpl_Study.hxx"
  31 #include "SALOMEDSImpl_Attributes.hxx"
  32
  33 #include "DF_ChildIterator.hxx"
  34
  35 #include <list>
  36
  37 #define USE_CASE_LABEL_TAG           2
  38 #define USE_CASE_GUID                "AA43BB12-D9CD-11d6-945D-0050DA506788"
  39
  40 namespace {
  41   // comparator to sort use case nodes in ascending order
  42   struct AscSortSOs {
  43     bool operator()( SALOMEDSImpl_SObject firstSO, SALOMEDSImpl_SObject secondSO ) const {
  44       std::string firstName, secondName;
  45       SALOMEDSImpl_SObject refSO;
  46       firstSO.ReferencedObject(refSO) ?
  47         firstName = refSO.GetName() :
  48         firstName = firstSO.GetName();
  49       secondSO.ReferencedObject(refSO) ?
  50         secondName = refSO.GetName() :
  51         secondName = secondSO.GetName();
  52       return firstName < secondName;
  53     }
  54   };
  55
  56   // comparator to sort use case nodes in descending order
  57   struct DescSortSOs {
  58     bool operator()( SALOMEDSImpl_SObject firstSO, SALOMEDSImpl_SObject secondSO ) const {
  59       std::string firstName, secondName;
  60       SALOMEDSImpl_SObject refSO;
  61       firstSO.ReferencedObject(refSO) ?
  62         firstName = refSO.GetName() :
  63         firstName = firstSO.GetName();
  64       secondSO.ReferencedObject(refSO) ?
  65         secondName = refSO.GetName() :
  66         secondName = secondSO.GetName();
  67       return firstName > secondName;
  68     }
  69   };
  70 }
  71
  72 //============================================================================
  73 /*! Function : constructor
  74  *  Purpose  :
  75  */
  76 //============================================================================
  77 SALOMEDSImpl_UseCaseBuilder::SALOMEDSImpl_UseCaseBuilder(DF_Document* theDocument)
  78 :_doc(theDocument)
  79 {
  80   if(!_doc) return;
  81
  82   DF_Label aLabel = _doc->Main().Root().FindChild(USE_CASE_LABEL_TAG); //Iterate all use cases
  83   if(!(_root = (SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(std::string(USE_CASE_GUID)))) {
  84     _root = SALOMEDSImpl_AttributeTreeNode::Set(aLabel, std::string(USE_CASE_GUID));
  85   }
  86
  87   SALOMEDSImpl_AttributeReference* aRef = NULL;
  88   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
  89     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), _root->Label());
  90   }
  91
  92   if(!aLabel.FindAttribute(SALOMEDSImpl_AttributeName::GetID())) {
  93     SALOMEDSImpl_AttributeName::Set(aLabel, "Use cases");
  94   }
  95 }
  96
  97 //============================================================================
  98 /*! Function : destructor
  99  *  Purpose  :
 100  */
 101 //============================================================================
 102 SALOMEDSImpl_UseCaseBuilder::~SALOMEDSImpl_UseCaseBuilder()
 103 {
 104 }
 105
 106
 107 //============================================================================
 108 /*! Function : Append
 109  *  Purpose  :
 110  */
 111 //============================================================================
 112 bool SALOMEDSImpl_UseCaseBuilder::Append(const SALOMEDSImpl_SObject& theObject)
 113 {
 114   if(!_root || !theObject) return false;
 115
 116   DF_Label aLabel = theObject.GetLabel();
 117   if(aLabel.IsNull()) return false;
 118
 119   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 120   SALOMEDSImpl_AttributeTreeNode* aCurrentNode = NULL;
 121   aNode = SALOMEDSImpl_AttributeTreeNode::Set(aLabel, _root->ID());
 122   aNode->Remove();
 123
 124   SALOMEDSImpl_AttributeReference* aRef;
 125   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
 126     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), _root->Label());
 127   }
 128
 129   DF_Label aCurrent = aRef->Get();
 130   if(aCurrent.IsNull() || !(aCurrentNode=(SALOMEDSImpl_AttributeTreeNode*)aCurrent.FindAttribute(_root->ID())))
 131     aCurrentNode = _root;
 132
 133   aCurrentNode->Append(aNode);
 134
 135   // Mantis issue 0020136: Drag&Drop in OB
 136   theObject.GetStudy()->addSO_Notification(theObject);
 137
 138   return true;
 139 }
 140
 141  //============================================================================
 142 /*! Function : Remove
 143  *  Purpose  :
 144  */
 145 //============================================================================
 146 bool SALOMEDSImpl_UseCaseBuilder::Remove(const SALOMEDSImpl_SObject& theObject)
 147 {
 148   if(!_root || !theObject) return false;
 149
 150   DF_Label aLabel = theObject.GetLabel();
 151   if(aLabel.IsNull()) return false;
 152
 153   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 154   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 155
 156   aNode->Remove();
 157
 158   std::vector<DF_Attribute*> aList;
 159   aList.push_back(aNode);
 160
 161   SALOMEDSImpl_AttributeReference* aRef = NULL;
 162   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
 163     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), _root->Label());
 164   }
 165
 166   DF_Label aCurrent = aRef->Get();
 167
 168   SALOMEDSImpl_ChildNodeIterator aChildItr(aNode, true);
 169   for(; aChildItr.More(); aChildItr.Next())
 170     aList.push_back(aChildItr.Value());
 171
 172   for(int i = 0, len = aList.size(); i<len; i++) {
 173     if(aList[i]->Label() ==  aCurrent) { //The current node is removed
 174       aRef->Set(_root->Label()); //Reset the current node to the root
 175     }
 176     aList[i]->Label().ForgetAttribute(_root->ID());
 177   }
 178
 179   return true;
 180 }
 181
 182
 183 //============================================================================
 184 /*! Function : AppendTo
 185  *  Purpose  :
 186  */
 187 //============================================================================
 188 bool SALOMEDSImpl_UseCaseBuilder::AppendTo(const SALOMEDSImpl_SObject& theFather,
 189                                            const SALOMEDSImpl_SObject& theObject)
 190 {
 191   if(!_root || !theFather || !theObject) return false;
 192
 193   DF_Label aFatherLabel = theFather.GetLabel(), aLabel = theObject.GetLabel();
 194   if(aFatherLabel == aLabel) return false;
 195
 196   SALOMEDSImpl_AttributeTreeNode *aFather = NULL, *aNode = NULL;
 197
 198   if(aFatherLabel.IsNull()) return false;
 199   if(!(aFather=(SALOMEDSImpl_AttributeTreeNode*)aFatherLabel.FindAttribute(_root->ID()))) return false;
 200
 201   if(aLabel.IsNull()) return false;
 202   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) {
 203     aNode = SALOMEDSImpl_AttributeTreeNode::Set(aLabel, _root->ID());
 204   }
 205
 206   aNode->Remove();
 207
 208   bool ret = aFather->Append(aNode);
 209
 210   // Mantis issue 0020136: Drag&Drop in OB
 211   theObject.GetStudy()->addSO_Notification(theObject);
 212
 213   return ret;
 214 }
 215
 216 //============================================================================
 217 /*! Function : InsertBefore
 218  *  Purpose  :
 219  */
 220 //============================================================================
 221 bool SALOMEDSImpl_UseCaseBuilder::InsertBefore(const SALOMEDSImpl_SObject& theFirst,
 222                                                const SALOMEDSImpl_SObject& theNext)
 223 {
 224   if(!_root || !theFirst || !theNext) return false;
 225
 226   DF_Label aFirstLabel = theFirst.GetLabel(), aLabel= theNext.GetLabel();
 227   if(aFirstLabel == aLabel) return false;
 228
 229   SALOMEDSImpl_AttributeTreeNode *aFirstNode = NULL, *aNode = NULL;
 230
 231   if(aFirstLabel.IsNull()) return false;
 232   if((aFirstNode=(SALOMEDSImpl_AttributeTreeNode*)aFirstLabel.FindAttribute(_root->ID()))) {
 233     aFirstNode->Remove();
 234     aFirstLabel.ForgetAttribute(aFirstNode->ID());
 235   }
 236
 237   aFirstNode = SALOMEDSImpl_AttributeTreeNode::Set(aFirstLabel, _root->ID());
 238
 239   if(aLabel.IsNull()) return false;
 240   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 241
 242   aFirstNode->Remove();
 243
 244   bool ret = aNode->InsertBefore(aFirstNode);
 245
 246   // Mantis issue 0020136: Drag&Drop in OB
 247   theFirst.GetStudy()->addSO_Notification(theFirst);
 248
 249   return ret;
 250 }
 251
 252
 253 //============================================================================
 254 /*! Function : SetCurrentObject
 255  *  Purpose  :
 256  */
 257 //============================================================================
 258 bool SALOMEDSImpl_UseCaseBuilder::SetCurrentObject(const SALOMEDSImpl_SObject& theObject)
 259 {
 260   if(!_root || !theObject) return false;
 261
 262   DF_Label aLabel = theObject.GetLabel();
 263   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 264   if(aLabel.IsNull()) return false;
 265   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 266
 267   SALOMEDSImpl_AttributeReference* aRef = NULL;
 268   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
 269     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), aNode->Label());
 270   }
 271
 272   aRef->Set(aNode->Label());
 273
 274   return true;
 275 }
 276
 277 //============================================================================
 278 /*! Function : SetRootCurrent
 279  *  Purpose  :
 280  */
 281 //============================================================================
 282 bool SALOMEDSImpl_UseCaseBuilder::SetRootCurrent()
 283 {
 284   if(!_root) return false;
 285
 286   SALOMEDSImpl_AttributeReference* aRef = NULL;
 287   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID())))
 288     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), _root->Label());
 289
 290   aRef->Set(_root->Label());
 291   return true;
 292 }
 293
 294 //============================================================================
 295 /*! Function : HasChildren
 296  *  Purpose  :
 297  */
 298 //============================================================================
 299 bool SALOMEDSImpl_UseCaseBuilder::HasChildren(const SALOMEDSImpl_SObject& theObject)
 300 {
 301   if(!_root) return false;
 302
 303   DF_Label aLabel;
 304   if (!theObject) aLabel = _root->Label();
 305   else
 306     aLabel = theObject.GetLabel();
 307   if(aLabel.IsNull()) return false;
 308
 309   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 310   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 311
 312   return (aNode->GetFirst());
 313 }
 314
 315 //============================================================================
 316 /*! Function : SortChildren
 317  *  Purpose  :
 318  */
 319 //============================================================================
 320 bool SALOMEDSImpl_UseCaseBuilder::SortChildren(const SALOMEDSImpl_SObject& theObject, bool theAscendingOrder)
 321 {
 322   if(!_root) return false;
 323
 324   DF_Label aLabel;
 325   if (!theObject) aLabel = _root->Label();
 326   else
 327     aLabel = theObject.GetLabel();
 328   if(aLabel.IsNull()) return false;
 329
 330   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 331   if (!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 332
 333   std::list<SALOMEDSImpl_SObject> aNodeSOs;
 334   for (SALOMEDSImpl_AttributeTreeNode* aChildNode=aNode->GetFirst(); aChildNode; aChildNode=aChildNode->GetNext() ) {
 335     SALOMEDSImpl_SObject aSO = SALOMEDSImpl_Study::SObject(aChildNode->Label());
 336     if (aSO) {
 337       aNodeSOs.push_back(aSO);
 338     }
 339   }
 340   if (aNodeSOs.empty()) return false;
 341
 342   //sort items by names in ascending/descending order
 343   theAscendingOrder ? aNodeSOs.sort( AscSortSOs() ) : aNodeSOs.sort( DescSortSOs() );
 344
 345   std::list<SALOMEDSImpl_SObject>::iterator it;
 346   for (it=aNodeSOs.begin(); it!=aNodeSOs.end(); ++it) {
 347     AppendTo(aNode->GetSObject(), *it);
 348   }
 349
 350   return true;
 351 }
 352
 353 //============================================================================
 354 /*! Function : GetFather
 355  *  Purpose  :
 356  */
 357 //============================================================================
 358 SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetFather(const SALOMEDSImpl_SObject& theObject)
 359 {
 360   SALOMEDSImpl_SObject so;
 361   if (!_root || !theObject) return so;
 362
 363   DF_Label aLabel = theObject.GetLabel();
 364   if (aLabel.IsNull()) return so;
 365
 366   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 367   if (!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return so;
 368
 369   SALOMEDSImpl_AttributeTreeNode* aFatherNode = aNode->GetFather();
 370   if (!aFatherNode) return so;
 371
 372   return aFatherNode->GetSObject();
 373 }
 374
 375 //============================================================================
 376 /*! Function : SetName
 377  *  Purpose  :
 378  */
 379 //============================================================================
 380 bool SALOMEDSImpl_UseCaseBuilder::SetName(const std::string& theName) {
 381   if(!_root) return false;
 382
 383   SALOMEDSImpl_AttributeName* aNameAttrib = NULL;
 384
 385   if (!(aNameAttrib=(SALOMEDSImpl_AttributeName*)_root->FindAttribute(SALOMEDSImpl_AttributeName::GetID())))
 386     aNameAttrib = SALOMEDSImpl_AttributeName::Set(_root->Label(), theName);
 387
 388   aNameAttrib->SetValue(theName);
 389
 390   return true;
 391 }
 392
 393
 394 //============================================================================
 395 /*! Function : GetCurrentObject
 396  *  Purpose  :
 397  */
 398 //============================================================================
 399 SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetCurrentObject()
 400 {
 401   SALOMEDSImpl_SObject so;
 402   if(!_root) return so;
 403
 404   SALOMEDSImpl_AttributeReference* aRef = NULL;
 405   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
 406     aRef = SALOMEDSImpl_AttributeReference::Set(_root->Label(), _root->Label());
 407   }
 408
 409   DF_Label aCurrent = aRef->Get();
 410   if(aCurrent.IsNull()) return so;
 411
 412   return SALOMEDSImpl_Study::SObject(aCurrent);
 413 }
 414
 415 //============================================================================
 416 /*! Function : GetName
 417  *  Purpose  :
 418  */
 419 //============================================================================
 420 std::string SALOMEDSImpl_UseCaseBuilder::GetName()
 421 {
 422   std::string aString;
 423   if(!_root) return aString;
 424
 425   SALOMEDSImpl_AttributeName* aName = NULL;
 426   if (!(aName=(SALOMEDSImpl_AttributeName*)_root->FindAttribute(SALOMEDSImpl_AttributeName::GetID()))) return aString;
 427   return aName->Value();
 428 }
 429
 430 //============================================================================
 431 /*! Function :  IsUseCase
 432  *  Purpose  :
 433  */
 434 //============================================================================
 435 bool SALOMEDSImpl_UseCaseBuilder::IsUseCase(const SALOMEDSImpl_SObject& theObject)
 436 {
 437   if(!theObject) return false;
 438   DF_Label aFather, aLabel = theObject.GetLabel();
 439   aFather = _doc->Main().Root().FindChild(USE_CASE_LABEL_TAG);
 440   if(aLabel.Father() == aFather) return true;
 441   return false;
 442 }
 443
 444 //============================================================================
 445 /*! Function :  IsUseCaseNode
 446  *  Purpose  :
 447  */
 448 //============================================================================
 449 bool SALOMEDSImpl_UseCaseBuilder::IsUseCaseNode(const SALOMEDSImpl_SObject& theObject)
 450 {
 451   if(!_root) return false;
 452
 453   DF_Label aLabel;
 454   if (!theObject) aLabel = _root->Label();
 455   else
 456     aLabel = theObject.GetLabel();
 457   if(aLabel.IsNull()) return false;
 458
 459   SALOMEDSImpl_AttributeTreeNode* aNode = NULL;
 460   if(!(aNode=(SALOMEDSImpl_AttributeTreeNode*)aLabel.FindAttribute(_root->ID()))) return false;
 461
 462   return true;
 463 }
 464
 465 //============================================================================
 466 /*! Function : NewUseCase
 467  *  Purpose  :
 468  */
 469 //============================================================================
 470 SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::AddUseCase(const std::string& theName)
 471 {
 472   std::string aBasicGUID(USE_CASE_GUID);
 473
 474   //Create a use cases structure if it not exists
 475
 476   SALOMEDSImpl_AttributeTreeNode *aFatherNode = NULL, *aNode = NULL;
 477   SALOMEDSImpl_AttributeInteger* anInteger = NULL;
 478   SALOMEDSImpl_AttributeReference* aRef = NULL;
 479
 480   DF_Label aLabel = _doc->Main().Root().FindChild(USE_CASE_LABEL_TAG);
 481
 482   if(!(aRef=(SALOMEDSImpl_AttributeReference*)_root->FindAttribute(SALOMEDSImpl_AttributeReference::GetID()))) {
 483     aRef = SALOMEDSImpl_AttributeReference::Set(aLabel, aLabel);
 484   }
 485
 486   if(!(aFatherNode=(SALOMEDSImpl_AttributeTreeNode*)aRef->Get().FindAttribute(aBasicGUID))) {
 487     aFatherNode = SALOMEDSImpl_AttributeTreeNode::Set(aRef->Get(), aBasicGUID);
 488   }
 489
 490   if(!(anInteger=(SALOMEDSImpl_AttributeInteger*)_root->FindAttribute(SALOMEDSImpl_AttributeInteger::GetID()))) {
 491     anInteger = SALOMEDSImpl_AttributeInteger::Set(aLabel, 0);
 492   }
 493
 494   //Create a new use case
 495   anInteger->SetValue(anInteger->Value()+1);
 496   DF_Label aChild = aLabel.FindChild(anInteger->Value());
 497   aNode = SALOMEDSImpl_AttributeTreeNode::Set(aChild, aBasicGUID);
 498   aNode->Remove();
 499   aFatherNode->Append(aNode);
 500   SALOMEDSImpl_AttributeName::Set(aChild, theName);
 501
 502   return SALOMEDSImpl_Study::SObject(aChild);
 503 }
 504
 505 //============================================================================
 506 /*! Function : GetUseCaseIterator
 507  *  Purpose  : Creates a new UseCase iterator, if anObject is null all use cases are iterated
 508  */
 509 //============================================================================
 510 SALOMEDSImpl_UseCaseIterator
 511 SALOMEDSImpl_UseCaseBuilder::GetUseCaseIterator(const SALOMEDSImpl_SObject& theObject)
 512 {
 513   DF_Label aLabel;
 514
 515   if(theObject) {
 516     aLabel = theObject.GetLabel(); //Iterate only sub tree in the use case
 517   }
 518   else {
 519     aLabel = _doc->Main().Root().FindChild(USE_CASE_LABEL_TAG); //Iterate all use cases
 520   }
 521
 522   return SALOMEDSImpl_UseCaseIterator(aLabel, USE_CASE_GUID, false);
 523 }
 524
 525
 526 SALOMEDSImpl_SObject SALOMEDSImpl_UseCaseBuilder::GetSObject(const std::string& theEntry)
 527 {
 528   DF_Label L = DF_Label::Label(_root->Label(), theEntry);
 529   return SALOMEDSImpl_Study::SObject(L);
 530 }