Logical location of module.
More...
#include <JLocation.hh>
Logical location of module.
The logical location of a module consists of a string and floor number.
This class implements the JLANG::JComparable interface.
Definition at line 38 of file JLocation.hh.
◆ JLocation() [1/2]
JDETECTOR::JLocation::JLocation |
( |
| ) |
|
|
inline |
◆ JLocation() [2/2]
JDETECTOR::JLocation::JLocation |
( |
const int | string, |
|
|
const int | floor ) |
|
inline |
◆ getLocation() [1/2]
const JLocation & JDETECTOR::JLocation::getLocation |
( |
| ) |
const |
|
inline |
Get location.
- Returns
- location
Definition at line 70 of file JLocation.hh.
71 {
72 return static_cast<const JLocation&
>(*this);
73 }
JLocation()
Default constructor.
◆ getLocation() [2/2]
JLocation & JDETECTOR::JLocation::getLocation |
( |
| ) |
|
|
inline |
Get location.
- Returns
- location
Definition at line 81 of file JLocation.hh.
◆ setLocation()
void JDETECTOR::JLocation::setLocation |
( |
const JLocation & | location | ) |
|
|
inline |
Set location.
- Parameters
-
Definition at line 92 of file JLocation.hh.
93 {
94 static_cast<JLocation&
>(*this) = location;
95 }
◆ toString() [1/2]
std::string JDETECTOR::JLocation::toString |
( |
| ) |
const |
|
inline |
Convert module location to string.
- Returns
- string
Definition at line 103 of file JLocation.hh.
104 {
106 }
std::string toString() const
Convert module location to string.
◆ toString() [2/2]
std::string JDETECTOR::JLocation::toString |
( |
const std::string & | fmt, |
|
|
const std::string | target = "%" ) const |
|
inline |
Convert module loation to string.
The targets target
in the format string fmt
are consecutively replaced by floor
and string
.
- Parameters
-
- Returns
- string
Definition at line 119 of file JLocation.hh.
120 {
122
123 buffer.replace(target, string, 1);
124 buffer.replace(target,
floor, 1);
125
126 return buffer;
127 }
Wrapper class around STL string class.
◆ getString()
int JDETECTOR::JLocation::getString |
( |
| ) |
const |
|
inline |
Get string number.
- Returns
- string number
Definition at line 135 of file JLocation.hh.
◆ getFloor()
int JDETECTOR::JLocation::getFloor |
( |
| ) |
const |
|
inline |
Get floor number.
- Returns
- floor number
Definition at line 146 of file JLocation.hh.
◆ less()
bool JDETECTOR::JLocation::less |
( |
const JLocation & | location | ) |
const |
|
inline |
Less than method.
- Parameters
-
- Returns
- true if first location before second location; else false
Definition at line 158 of file JLocation.hh.
159 {
160 if (this->
getString() == location.getString())
161 return this->
getFloor() < location.getFloor();
162 else
163 return this->
getString() < location.getString();
164 }
int getFloor() const
Get floor number.
int getString() const
Get string number.
◆ operator>> [1/2]
std::istream & operator>> |
( |
std::istream & | in, |
|
|
JLocation & | location ) |
|
friend |
Read module location from input.
- Parameters
-
in | input stream |
location | module location |
- Returns
- input stream
Definition at line 174 of file JLocation.hh.
175 {
176 in >> location.string;
177 in >> location.floor;
178
179 return in;
180 }
◆ operator<< [1/2]
std::ostream & operator<< |
( |
std::ostream & | out, |
|
|
const JLocation & | location ) |
|
friend |
Write module location to output.
- Parameters
-
out | output stream |
location | module location |
- Returns
- output stream
Definition at line 190 of file JLocation.hh.
191 {
193
194 out << setw(4) << location.string;
195 out << ' ';
196 out << setw(2) << location.floor;
197
198 return out;
199 }
◆ operator>> [2/2]
Read module location from input.
- Parameters
-
in | reader |
location | module location |
- Returns
- reader
Definition at line 209 of file JLocation.hh.
210 {
211 in >> location.string;
212 in >> location.floor;
213
214 return in;
215 }
◆ operator<< [2/2]
Write module location to output.
- Parameters
-
out | writer |
location | module location |
- Returns
- writer
Definition at line 225 of file JLocation.hh.
226 {
227 out << location.string;
228 out << location.floor;
229
230 return out;
231 }
◆ string
int JDETECTOR::JLocation::string |
|
protected |
◆ floor
int JDETECTOR::JLocation::floor |
|
protected |
The documentation for this class was generated from the following file: