BaseObject.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 #ifndef BASEOBJECT_H
27 #define BASEOBJECT_H
28 
29 #include <iostream>
30 
31 // Foward declation of base object.
32 class BaseObject;
33 
37 std::ostream& operator<<(std::ostream& os, const BaseObject& o);
38 
42 std::istream& operator>>(std::istream& is, BaseObject& o);
43 
51 {
52 public:
56  BaseObject() = default;
57 
61  BaseObject(const BaseObject& p) = default;
62 
66  virtual ~BaseObject() = default;
67 
74  friend std::ostream& operator<<(std::ostream& os, const BaseObject& o);
75 
80  friend std::istream& operator>>(std::istream& is, BaseObject& o);
81 
86  virtual void read(std::istream& is) = 0;
87 
92  virtual void write(std::ostream& os) const = 0;
93 
97  virtual std::string getName() const = 0;
98 
102  virtual void moveInHandler(unsigned int index);
103 
107  void setIndex(unsigned int index);
108 
113  void setId(unsigned long id);
114 
118  unsigned int getIndex() const
119  { return index_; };
120 
125  unsigned int getId() const
126  { return id_; }
127 
131  void setGroupId(unsigned groupId)
132  { groupId_ = groupId; }
133 
137  unsigned getGroupId() const
138  { return groupId_; }
139 
140 private:
144  unsigned int index_ = 0;
145 
149  unsigned int id_ = 0;
150 
157  unsigned int groupId_ = 0;
158 
159 };
160 
161 #endif
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
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:51
virtual std::string getName() const =0
A purely virtual function.
unsigned int groupId_
Identifier of a group within handler.
Definition: BaseObject.h:157
unsigned getGroupId() const
Definition: BaseObject.h:137
friend std::ostream & operator<<(std::ostream &os, const BaseObject &o)
A purely virtual method with an implementation which reads the index from the stream and assigns it t...
Definition: BaseObject.cc:36
unsigned int getId() const
Returns the unique identifier of any particular object.
Definition: BaseObject.h:125
unsigned int id_
unique identifier within handler (remains constant even if particle is moved)
Definition: BaseObject.h:149
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
unsigned int getIndex() const
Returns the index of the object in the handler.
Definition: BaseObject.h:118
BaseObject()=default
Default constructor.
void setIndex(unsigned int index)
Allows one to assign an index to an object in the handler/container.
Definition: BaseObject.cc:64
unsigned int index_
location in BaseHandler::objects_
Definition: BaseObject.h:144
void setGroupId(unsigned groupId)
Definition: BaseObject.h:131
friend 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
virtual void moveInHandler(unsigned int index)
Except that it is virtual, it does the same thing as setIndex() does.
Definition: BaseObject.cc:56
virtual void read(std::istream &is)=0
Definition: BaseObject.cc:81
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
BaseObject(const BaseObject &p)=default
Copy constructor, copies all the objects BaseObject contains.
virtual ~BaseObject()=default
virtual destructor