MercuryDPM  Alpha
 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-2014, 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 
35 std::ostream& operator<<(std::ostream& os, const BaseObject& o)
36 {
37  o.write(os);
38  return os;
39 }
40 
46 std::istream& operator>>(std::istream& is, BaseObject &o)
47 {
48  o.read(is);
49  return (is);
50 }
51 
56 {
57  index_ = 0;
58  id_ = 0;
59  logger(DEBUG,"BaseObject::BaseObject() finished");
60 }
61 
66 {
67  index_ = p.index_;
68  id_ = p.id_;
69  logger(DEBUG,"BaseObject::BaseObject(const BaseObject &p) finished");
70 }
71 
76 {
77  logger(DEBUG,"BaseObject::~BaseBoundary() finished");
78 }
79 
83 void BaseObject::moveInHandler(const unsigned int index)
84 {
85  index_ = index;
86 }
87 
91 void BaseObject::setIndex(const unsigned int index)
92 {
93  index_ = index;
94 }
95 
99 void BaseObject::setId(const unsigned int id)
100 {
101  id_ = id;
103 }
104 
108 unsigned int BaseObject::getIndex() const
109 {
110  return index_;
111 }
112 
116 unsigned int BaseObject::getId() const
117 {
118  return id_;
119 }
120 
124 void BaseObject::read(std::istream& is)
125 {
126  std::string dummy;
127  is >> dummy >> id_;
128 }
129 
133 void BaseObject::write(std::ostream& os) const
134 {
135  os << getName();
136  os << " id " << id_;
137 }
void setIndex(const unsigned int index)
Allows one to assign an index to an object in the handler/container.
Definition: BaseObject.cc:91
unsigned int getId() const
Returns the unique identifier of any particular object.
Definition: BaseObject.cc:116
unsigned int getIndex() const
Returns the index of the object in the handler.
Definition: BaseObject.cc:108
virtual void moveInHandler(const unsigned int index)
Except that it is virtual, it does the same thing as setIndex() does.
Definition: BaseObject.cc:83
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:46
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
It is an abstract base class due to the purely virtual functions declared below. Even if the function...
Definition: BaseObject.h:49
unsigned int index_
location in BaseHandler::objects_
Definition: BaseObject.h:115
unsigned int id_
unique identifier within handler (remains constant even if particle is moved)
Definition: BaseObject.h:120
void setId(const unsigned int id)
Assigns a unique identifier to each object in the handler (container) which remains constant even aft...
Definition: BaseObject.cc:99
virtual ~BaseObject()
virtual destructor
Definition: BaseObject.cc:75
virtual std::string getName() const =0
A purely virtual function.
virtual void read(std::istream &is)=0
A purely virtual method with an implementation which reads the index from the stream and assigns it t...
Definition: BaseObject.cc:124
BaseObject()
Default constructor.
Definition: BaseObject.cc:55
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:133
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:35