Developer Documentation
GroupBackup.cc
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #include "GroupBackup.hh"
45 
46 #include <OpenFlipper/common/BackupData.hh>
48 
49 //-----------------------------------------------------------------------------
50 
51 GroupBackup::GroupBackup(IdList _objectIDs, QString _name)
52  : BaseBackup(_name),
53  objectIDs_(_objectIDs)
54 {
55 // std::cerr << "Create GroupBackup with name:" << name_.toStdString() << "(id : " << id_ << ")" << std::endl;
56 
57  //store the backup ids of all objects
58  for (unsigned int i=0; i < objectIDs_.size(); ++i ){
59  BaseObjectData* object = 0;
60  PluginFunctions::getObject(objectIDs_[i], object);
61  int id = -1;
62 
63  if ( object != 0 ){
64 
65  //get backup object data
66  BackupData* backupData = 0;
67 
68  if ( object->hasObjectData( OBJECT_BACKUPS ) ){
69  backupData = dynamic_cast< BackupData* >(object->objectData(OBJECT_BACKUPS));
70  id = backupData->currentID();
71 
72  //add links so that object backups know that they have to be applied together
73  if ( objectIDs_.size() > 1 )
74  backupData->setLinks(_objectIDs);
75  }
76  }
77  backupIDs_.push_back(id);
78  }
79 }
80 
81 //-----------------------------------------------------------------------------
82 
83 GroupBackup::~GroupBackup(){
84 // std::cerr << "Delete GroupBackup with name:" << name_.toStdString() << "(id : " << id_ << ")" << std::endl;
85 }
86 
87 //-----------------------------------------------------------------------------
88 
90 
91 }
92 
93 //-----------------------------------------------------------------------------
94 
95 const IdList& GroupBackup::objectIDs() const{
96  return objectIDs_;
97 }
98 
99 //-----------------------------------------------------------------------------
100 
101 bool GroupBackup::contains( int _objectid ) const{
102  return std::find(objectIDs_.begin(), objectIDs_.end(), _objectid) != objectIDs_.end();
103 }
104 
105 //-----------------------------------------------------------------------------
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
void setLinks(IdList _objectIDs)
Definition: BackupData.cc:233
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
Abstract class that is used to store backups.
Definition: BackupData.hh:57
void apply()
Revert this backup.
Definition: GroupBackup.cc:89
int currentID()
return the id of the current backup state
Definition: BackupData.cc:173
Class that encapsulates a backup.
Definition: BaseBackup.hh:53
bool hasObjectData(QString _dataName)
Checks if object data with given name is available.
Definition: BaseObject.cc:795