MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BaseObject.cc
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 
27 #include "BaseObject.h"
28 #include "Logger.h"
29 #include "Math/Helpers.h"
30 
36 std::ostream& operator<<(std::ostream& os, const BaseObject& o)
37 {
38  o.write(os);
39  return os;
40 }
41 
47 std::istream& operator>>(std::istream& is, BaseObject& o)
48 {
49  o.read(is);
50  return (is);
51 }
52 
56 void BaseObject::moveInHandler(const unsigned int index)
57 {
58  index_ = index;
59 }
60 
64 void BaseObject::setIndex(const unsigned int index)
65 {
66  index_ = index;
67 }
68 
72 void BaseObject::setId(unsigned long id)
73 {
74  id_ = id;
76 }
77 
81 void BaseObject::read(std::istream& is)
82 {
83  std::string dummy;
84  is >> dummy >> id_;
86 }
87 
91 void BaseObject::write(std::ostream& os) const
92 {
93  os << getName();
94  os << " id " << id_;
95  if (groupId_) os << " groupID " << groupId_;
96 }
97 
void setIndex(unsigned int index)
Allows one to assign an index to an object in the handler/container.
Definition: BaseObject.cc:64
std::istream & operator>>(std::istream &is, BaseObject &o)
Operator overloading for reading the data from an input stream into the BAseObject "o"...
Definition: BaseObject.cc:47
It is an abstract base class due to the purely virtual functions declared below. Even if the function...
Definition: BaseObject.h:50
unsigned int index_
location in BaseHandler::objects_
Definition: BaseObject.h:144
virtual void moveInHandler(unsigned int index)
Except that it is virtual, it does the same thing as setIndex() does.
Definition: BaseObject.cc:56
unsigned int id_
unique identifier within handler (remains constant even if particle is moved)
Definition: BaseObject.h:149
virtual std::string getName() const =0
A purely virtual function.
bool readOptionalVariable(std::istream &is, const std::string &name, T &variable)
Reads optional variables in the restart file.
Definition: Helpers.h:247
virtual void read(std::istream &is)=0
Definition: BaseObject.cc:81
unsigned int groupId_
Identifier of a group within handler.
Definition: BaseObject.h:157
virtual void write(std::ostream &os) const =0
A purely virtual function which has an implementation which writes the name and the object id_ to the...
Definition: BaseObject.cc:91
void setId(unsigned long id)
Assigns a unique identifier to each object in the handler (container) which remains constant even aft...
Definition: BaseObject.cc:72
std::ostream & operator<<(std::ostream &os, const BaseObject &o)
Operator overloading for passing the data from the BaseObject "o" into the output stream...
Definition: BaseObject.cc:36