Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JDETECTOR::JDetector Class Reference

Detector data structure. More...

#include <JDetector.hh>

Inheritance diagram for JDETECTOR::JDetector:
JLANG::JObjectID JDETECTOR::JDetectorVersion JDETECTOR::JDetectorHeader std::vector< JModule > JLANG::JMultiEquals< JClass_t, JType_t > JIO::JSerialisable JLANG::JComparable< JObjectID > JLANG::JComparable< JObjectID, int > JDETECTOR::JVersion JUTC::JUTCTimeRange JUTM::JUTMGrid JUTM::JUTMPosition JLANG::JEquals< JFirst_t, JSecond_t > JLANG::JComparable< JFirst_t, JSecond_t > JTOOLS::JRange< T, JComparator_t > JLANG::JEquals< JFirst_t, JSecond_t > JMATH::JMath< JFirst_t, JSecond_t > JTOOLS::JPair< T, T > JLANG::JEquals< JFirst_t, JSecond_t > JMATH::JMath< JFirst_t, JSecond_t > JDETECTOR::JMonteCarloDetector JDYNAMICS::JDynamics

Public Types

enum  start_of_comment_type { OLD_START_OF_COMMENT , NEW_START_OF_COMMENT }
 Enumeration for different lengths of start of comment in binary I/O. More...
 
enum  JVersion_t {
  V1 = 1 , V2 = 2 , V3 = 3 , V4 = 4 ,
  V5 = 5
}
 Enumeration of version types. More...
 
typedef std::pair< T, T > pair_type
 
typedef JRange< T, JComparator_t > range_type
 
typedef JLANG::JClass< T >::argument_type argument_type
 
typedef T key_type
 
typedef T mapped_type
 

Public Member Functions

 JDetector ()
 Default constructor.
 
 JDetector (const JDetectorID &id, const JVersion &version, const JDetectorHeader &header)
 Constructor.
 
void setVersion (const JVersion &version)
 Set version.
 
bool setVersion (const JDetectorVersion::JVersion_t &version, const bool force=false)
 Set version.
 
bool setToLatestVersion ()
 Set to latest version.
 
void setModuleStatus (const int bit)
 Set status of all modules.
 
void resetModuleStatus (const int bit)
 Reset status of all modules.
 
void setPMTStatus (const int bit)
 Set status of all PMTs.
 
void resetPMTStatus (const int bit)
 Reset status of all PMTs.
 
JDetectoroperator+= (const JVector3D &pos)
 Move detector elements.
 
JDetectoroperator-= (const JVector3D &pos)
 Move detector elements.
 
const JModulegetModule (const JModuleAddress &address) const
 Get module parameters.
 
JModulegetModule (const JModuleAddress &address)
 Get module parameters.
 
bool hasModule (const JLocation &location) const
 Check availability of module parameters.
 
const JModulegetModule (const JLocation &location) const
 Get module parameters.
 
JModulegetModule (const JLocation &location)
 Get module parameters.
 
const JPMTgetPMT (const JPMTAddress &address) const
 Get PMT parameters.
 
JPMTgetPMT (const JPMTAddress &address)
 Get PMT parameters.
 
virtual JReaderread (JReader &in) override
 Read from input.
 
virtual JWriterwrite (JWriter &out) const override
 Write to output.
 
int getID () const
 Get identifier.
 
int & getID ()
 Get identifier.
 
void setID (const int id)
 Set identifier.
 
bool less (const JObjectID &object) const
 Less than method.
 
bool less (const int id) const
 Less than method.
 
bool more (const int id) const
 More than method.
 
bool hasVersion () const
 Check validity of version.
 
const std::string & getVersion () const
 Get version.
 
void setVersion (const std::string &version)
 Set version.
 
bool less (const JVersion &version) const
 Less-than method.
 
const JDetectorHeadergetDetectorHeader () const
 Get detector header.
 
bool equals (const JDetectorHeader &header, const double precision=std::numeric_limits< double >::min()) const
 Check equality.
 
bool equals (const range_type &range) const
 Equal method.
 
bool equals (const JUTMGrid &grid) const
 Check equality.
 
JProperties getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters())
 Get properties of this class.
 
JProperties getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters()) const
 Get properties of this class.
 
const JUTCTimeRangegetUTCTimeRange () const
 Get UTC time range.
 
JUTCTimeRangegetUTCTimeRange ()
 Get UTC time range.
 
void setUTCTimeRange (const JRange< double > &timerange)
 Set UTC time range.
 
 operator pair_type () const
 Type conversion operator.
 
const range_typegetRange () const
 Get range.
 
void setRange (const range_type &range)
 Set range.
 
void setRange (argument_type x, argument_type y)
 Set lower and upper limit.
 
template<class R >
void setRange (R first, R second)
 Set range.
 
template<class JElement_t , class JAllocator_t >
void setRange (const array_type< JElement_t, JAllocator_t > &buffer)
 Set lower and upper limit according to input data.
 
getLowerLimit () const
 Get lower limit.
 
getUpperLimit () const
 Get upper limit.
 
void setLowerLimit (argument_type x)
 Set lower limit.
 
void setUpperLimit (argument_type y)
 Set upper limit.
 
void fixLowerLimit (argument_type x)
 Fix lower limit.
 
void fixUpperLimit (argument_type y)
 Fix upper limit.
 
getLength () const
 Get length (difference between upper and lower limit).
 
void setLength (argument_type length)
 Set length (difference between upper and lower limit).
 
bool is_valid () const
 Check validity of range.
 
bool in_range (argument_type x) const
 Test whether value is inside range.
 
bool operator() (argument_type x) const
 Test whether value is inside range.
 
constrain (argument_type x) const
 Constrain value to range.
 
mod (argument_type x) const
 Modulo value with respect to range.
 
bool overlap (const range_type &range) const
 Test overlap with given range.
 
range_typeinclude (argument_type x)
 Include given value to range.
 
range_typejoin (const range_type &range)
 Join ranges.
 
range_typecombine (const range_type &range)
 Combine ranges.
 
range_typeadd (argument_type x)
 Add offset.
 
range_typeadd (const range_type &range)
 Add offsets.
 
JUTMPositionadd (const JUTMPosition &pos)
 Add UTM position.
 
range_typesub (argument_type x)
 Subtract offset.
 
range_typesub (const range_type &range)
 Subtract offsets.
 
JUTMPositionsub (const JUTMPosition &pos)
 Subtract UTM position.
 
range_typemul (const double factor)
 Multiply range.
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object.
 
JUTMPositionmul (const double factor)
 Scale UTM position.
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object.
 
range_typediv (const double factor)
 Divide range.
 
JUTMPositiondiv (const double factor)
 Scale UTM position.
 
const key_type & getKey () const
 
const std::string & getKey () const
 Get key.
 
const mapped_typegetValue () const
 
mapped_typegetValue ()
 
const JUTMGridgetUTMGrid () const
 Get UTM grid.
 
void setUTMGrid (const JUTMGrid &grid)
 Set UTM grid.
 
const std::string & getWGS () const
 Get WGS.
 
const std::string & getUTMZone () const
 Get UTM zone.
 
int getUTMValue () const
 Get UTM zone by numerical value.
 
std::string toString () const
 Convert UTM grid.
 
const JUTMPositiongetUTMPosition () const
 Get UTM position.
 
void setUTMPosition (const JUTMPosition &position)
 Set UTM position.
 
JPosition3D getPosition () const
 Get position.
 
 operator JPosition3D () const
 Type conversion operator.
 
double getUTMEast () const
 Get UTM east.
 
double getUTMNorth () const
 Get UTM north.
 
double getUTMZ () const
 Get UTM Z.
 
double getX () const
 Get x.
 
double getY () const
 Get y.
 
double getZ () const
 Get z.
 
JUTMPositionnegate ()
 Negate UTM position.
 
double getDisplacement (const JUTMPosition &position) const
 Get displacement to position.
 

Static Public Member Functions

static start_of_comment_type getStartOfComment ()
 Get option for short start of comment in binary I/O.
 
static void setStartOfComment (const start_of_comment_type option)
 Set option for short start of comment in binary I/O.
 
static JEquationParametersgetEquationParameters ()
 Get equation parameters.
 
static void setEquationParameters (const JEquationParameters &equation)
 Set equation parameters.
 
static T getMinimum ()
 Get minimum possible value.
 
static T getMaximum ()
 Get maximum possible value.
 
static JRange< T, JComparator_t > DEFAULT_RANGE ()
 Default range.
 
static JUTMGrid valueOf (const std::string &buffer)
 Extract UTM grid.
 

Public Attributes

JComment comment
 
JComparator_t compare
 Function object for comparisons.
 
first
 
second
 

Protected Member Functions

void setVersion () const
 Set version.
 
template<class R >
void setRange (R first, R second, const JLANG::JBool< false > &option)
 Set range.
 
template<class R >
void setRange (R first, R second, const JLANG::JBool< true > &option)
 Set range.
 

Static Protected Member Functions

static start_of_comment_typeget_start_of_comment ()
 Get option for short start of comment in binary I/O.
 

Protected Attributes

int __id
 
std::string version
 
std::string key
 
std::string wgs
 
std::string zone
 
double east
 
double north
 
double z
 

Static Protected Attributes

static const size_t LENGTH_START_OF_COMMENT = sizeof(JDetectorID)
 Length of start of comment in binary I/O.
 

Friends

std::istream & operator>> (std::istream &in, JDetector &detector)
 Read detector from input.
 
std::ostream & operator<< (std::ostream &out, const JDetector &detector)
 Write detector to output.
 

Detailed Description

Detector data structure.

A detector consists of a header and a list of modules, each of which consists of a list of PMTs. Each PMT comprises position, orientation and time calibration data. Note that the index of the PMT in the module data structure corresponds to the readout channel (TDC).

The following formats and file name extension are supported:

extension format function
".detx" ASCII I/O
".gz" gzipped ASCII I/O
".datx" binary I/O
".det" ASCII I

The different formats can transparently be read and written using the methods:

   inline void load(const JString& file_name, JDetector& detector);
   inline void store(const JString& file_name, const JDetector& detector);

respectively. These methods are available in the include file JDetectorToolkit.hh.

The JDETECTOR::JModuleRouter and JDETECTOR::JPMTRouter classes provide for fast look-up methods of module and PMT calibration data for real data and Monte Carlo data, respectively.
Note that the (not) equal operator strictly applies to the detector identifier and version. For quantitative comparisons, use JCompareDetector.cc.
The official detector description document is available on the google drive for anyone with a KM3NeT account.
It can directly be found at this link.

For a given detector, the module identifier (JModule::getID) and the PMT identifier (JPMT::getID) are unique.
The serial number in the UPI of a PMT is equal to its identifier in the detector description.
For more information on the PBS (product breakdown structure) and UPI (universal product identifier), see this link.

Definition at line 89 of file JDetector.hh.

Member Typedef Documentation

◆ pair_type

template<class T , class JComparator_t = std::less<T>>
std::pair<T,T> JTOOLS::JRange< T, JComparator_t >::pair_type
inherited

Definition at line 45 of file JRange.hh.

◆ range_type

template<class T , class JComparator_t = std::less<T>>
JRange<T, JComparator_t> JTOOLS::JRange< T, JComparator_t >::range_type
inherited

Definition at line 46 of file JRange.hh.

◆ argument_type

template<class T , class JComparator_t = std::less<T>>
JLANG::JClass<T>::argument_type JTOOLS::JRange< T, JComparator_t >::argument_type
inherited

Definition at line 47 of file JRange.hh.

◆ key_type

T JTOOLS::JPair< T, T >::key_type
inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

T JTOOLS::JPair< T, T >::mapped_type
inherited

Definition at line 33 of file JPair.hh.

Member Enumeration Documentation

◆ start_of_comment_type

Enumeration for different lengths of start of comment in binary I/O.

Enumerator
OLD_START_OF_COMMENT 
NEW_START_OF_COMMENT 

Definition at line 567 of file JDetector.hh.

◆ JVersion_t

Enumeration of version types.


Note that additional version types should be included in JGetDetectorVersion::JGetDetectorVersion.

Enumerator
V1 

First version.

V2 

Version with UTC time and UTM position data.

V3 

Version with PMT status field and comments.

V4 

Version with quaternion and time offset per module.

V5 

Version with module status field.

Definition at line 48 of file JDetectorVersion.hh.

48 {
49 V1 = 1, //!< First version
50 V2 = 2, //!< Version with UTC time and UTM position data
51 V3 = 3, //!< Version with PMT status field and comments
52 V4 = 4, //!< Version with quaternion and time offset per module
53 V5 = 5 //!< Version with module status field
54 };
@ V2
Version with UTC time and UTM position data.
@ V5
Version with module status field.
@ V4
Version with quaternion and time offset per module.
@ V3
Version with PMT status field and comments.

Constructor & Destructor Documentation

◆ JDetector() [1/2]

JDETECTOR::JDetector::JDetector ( )
inline

Default constructor.

Definition at line 101 of file JDetector.hh.

101 :
102 JDetectorID(),
106 JSerialisable()
107 {}
JDetectorHeader()
Default constructor.
JLANG::JObjectID JDetectorID
Type definition of detector identifier.
JDetectorVersion()
Default constructor.

◆ JDetector() [2/2]

JDETECTOR::JDetector::JDetector ( const JDetectorID & id,
const JVersion & version,
const JDetectorHeader & header )
inline

Constructor.

Parameters
iddetector identifier
versionversion
headerheader

Definition at line 117 of file JDetector.hh.

119 :
120 JDetectorID(id),
122 JDetectorHeader (header),
124 JSerialisable()
125 {
126 setVersion();
127 }
void setVersion() const
Set version.
Definition JDetector.hh:600

Member Function Documentation

◆ setVersion() [1/4]

void JDETECTOR::JDetector::setVersion ( const JVersion & version)
inline

Set version.

Parameters
versionversion

Definition at line 135 of file JDetector.hh.

136 {
137 static_cast<JDetectorVersion&>(*this).setVersion(version.getVersion());
138
139 setVersion();
140 }

◆ setVersion() [2/4]

bool JDETECTOR::JDetector::setVersion ( const JDetectorVersion::JVersion_t & version,
const bool force = false )
inline

Set version.

Note that the version is only set to a higher version or when forced to set it.

Parameters
versionversion
forceforce setting of version
Returns
true if set; else false

Definition at line 152 of file JDetector.hh.

153 {
154 if (this->getVersion() == JDetectorVersion() || version > getDetectorVersion(this->getVersion()) || force) {
155
157
158 return true;
159 }
160
161 return false;
162 }
static const JGetDetectorVersion getDetectorVersion
Function object to map detector version to numerical value.
static const JPutDetectorVersion putDetectorVersion(getDetectorVersion)
Function object to map numerical value to detector version.
const std::string & getVersion() const
Get version.

◆ setToLatestVersion()

bool JDETECTOR::JDetector::setToLatestVersion ( )
inline

Set to latest version.

Returns
true if set; else false

Definition at line 170 of file JDetector.hh.

171 {
173 }
T getLatestDetectorVersion()
Get latest detector version.

◆ setModuleStatus()

void JDETECTOR::JDetector::setModuleStatus ( const int bit)
inline

Set status of all modules.

Parameters
bitbit

Definition at line 181 of file JDetector.hh.

182 {
183 for (iterator module = this->begin(); module != this->end(); ++module) {
184 module->getStatus().set(bit);
185 }
186 }

◆ resetModuleStatus()

void JDETECTOR::JDetector::resetModuleStatus ( const int bit)
inline

Reset status of all modules.

Parameters
bitbit

Definition at line 194 of file JDetector.hh.

195 {
196 for (iterator module = this->begin(); module != this->end(); ++module) {
197 module->getStatus().reset(bit);
198 }
199 }

◆ setPMTStatus()

void JDETECTOR::JDetector::setPMTStatus ( const int bit)
inline

Set status of all PMTs.

Parameters
bitbit

Definition at line 207 of file JDetector.hh.

208 {
209 for (iterator module = this->begin(); module != this->end(); ++module) {
210 for (JModule::iterator pmt = module->begin(); pmt != module->end(); ++pmt) {
211 pmt->getStatus().set(bit);
212 }
213 }
214 }

◆ resetPMTStatus()

void JDETECTOR::JDetector::resetPMTStatus ( const int bit)
inline

Reset status of all PMTs.

Parameters
bitbit

Definition at line 222 of file JDetector.hh.

223 {
224 for (iterator module = this->begin(); module != this->end(); ++module) {
225 for (JModule::iterator pmt = module->begin(); pmt != module->end(); ++pmt) {
226 pmt->getStatus().reset(bit);
227 }
228 }
229 }

◆ operator+=()

JDetector & JDETECTOR::JDetector::operator+= ( const JVector3D & pos)
inline

Move detector elements.

Parameters
posoffset position
Returns
this JDetector

Definition at line 238 of file JDetector.hh.

239 {
240 for (iterator i = begin(); i != end(); ++i) {
241 i->add(pos);
242 }
243
244 return *this;
245 }

◆ operator-=()

JDetector & JDETECTOR::JDetector::operator-= ( const JVector3D & pos)
inline

Move detector elements.

Parameters
posoffset position
Returns
this JDetector

Definition at line 254 of file JDetector.hh.

255 {
256 for (iterator i = begin(); i != end(); ++i) {
257 i->sub(pos);
258 }
259
260 return *this;
261 }

◆ getModule() [1/4]

const JModule & JDETECTOR::JDetector::getModule ( const JModuleAddress & address) const
inline

Get module parameters.

Parameters
addressmodule address
Returns
module parameters

Definition at line 270 of file JDetector.hh.

271 {
272 return at(address.first);
273 }

◆ getModule() [2/4]

JModule & JDETECTOR::JDetector::getModule ( const JModuleAddress & address)
inline

Get module parameters.

Parameters
addressmodule address
Returns
module parameters

Definition at line 282 of file JDetector.hh.

283 {
284 return at(address.first);
285 }

◆ hasModule()

bool JDETECTOR::JDetector::hasModule ( const JLocation & location) const
inline

Check availability of module parameters.

Parameters
locationmodule location
Returns
true if available; else false

Definition at line 294 of file JDetector.hh.

295 {
296 for (JDetector::const_iterator module = this->begin(); module != this->end(); ++module) {
297 if (module->getLocation() == location) {
298 return true;
299 }
300 }
301
302 return false;
303 }

◆ getModule() [3/4]

const JModule & JDETECTOR::JDetector::getModule ( const JLocation & location) const
inline

Get module parameters.

Parameters
locationmodule location
Returns
module parameters

Definition at line 312 of file JDetector.hh.

313 {
314 for (JDetector::const_iterator module = this->begin(); module != this->end(); ++module) {
315 if (module->getLocation() == location) {
316 return *module;
317 }
318 }
319
320 THROW(JIndexOutOfRange, "Invalid location " << location);
321 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.

◆ getModule() [4/4]

JModule & JDETECTOR::JDetector::getModule ( const JLocation & location)
inline

Get module parameters.

Parameters
locationmodule location
Returns
module parameters

Definition at line 330 of file JDetector.hh.

331 {
332 for (JDetector::iterator module = this->begin(); module != this->end(); ++module) {
333 if (module->getLocation() == location) {
334 return *module;
335 }
336 }
337
338 THROW(JIndexOutOfRange, "Invalid location " << location);
339 }

◆ getPMT() [1/2]

const JPMT & JDETECTOR::JDetector::getPMT ( const JPMTAddress & address) const
inline

Get PMT parameters.

Parameters
addressJPMTAddress
Returns
JPMT

Definition at line 348 of file JDetector.hh.

349 {
350 return at(address.first).at(address.second);
351 }

◆ getPMT() [2/2]

JPMT & JDETECTOR::JDetector::getPMT ( const JPMTAddress & address)
inline

Get PMT parameters.

Parameters
addressJPMTAddress
Returns
JPMT

Definition at line 360 of file JDetector.hh.

361 {
362 return at(address.first).at(address.second);
363 }

◆ read()

virtual JReader & JDETECTOR::JDetector::read ( JReader & in)
inlineoverridevirtual

Read from input.

Parameters
inreader
Returns
reader

Implements JIO::JSerialisable.

Definition at line 473 of file JDetector.hh.

474 {
475 using namespace std;
476 using namespace JPP;
477
478 this->clear();
479
481
482 char prefix[sizeof(JDetectorID)];
483
484 for (string buffer; in.read(prefix, N) == N && count(prefix, prefix + N, JComment::START_COMMENT) == N; ) {
485
486 in >> buffer;
487
488 this->comment.add(buffer);
489 }
490
491 if (this->comment.empty()) {
492 THROW(JIOException, "Missing comments");
493 }
494
495 in.read(&prefix[N], sizeof(JDetectorID) - N);
496
497 JByteArrayReader is(prefix, N);
498
499 int number_of_modules;
500
501 is >> static_cast<JDetectorID&> (*this);
502 in >> static_cast<JDetectorVersion&>(*this);
503 in >> static_cast<JDetectorHeader&> (*this);
504 in >> number_of_modules;
505
506 this->setVersion();
507 this->resize(number_of_modules);
508
509 for (JDetector::iterator out = this->begin(); number_of_modules != 0; --number_of_modules, ++out) {
510 in >> *out;
511 }
512
513 return in;
514 }
Data structure for detector header.
static const size_t LENGTH_START_OF_COMMENT
Length of start of comment in binary I/O.
Definition JDetector.hh:623
static start_of_comment_type getStartOfComment()
Get option for short start of comment in binary I/O.
Definition JDetector.hh:578
Byte array binary input.
Exception for I/O.
Auxiliary class for object identification.
Definition JObjectID.hh:25
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
static constexpr char START_COMMENT
start comment
Definition JComment.hh:48
JComment & add(const std::string &comment)
Add comment.
Definition JComment.hh:100

◆ write()

virtual JWriter & JDETECTOR::JDetector::write ( JWriter & out) const
inlineoverridevirtual

Write to output.

Parameters
outwriter
Returns
writer

Implements JIO::JSerialisable.

Definition at line 523 of file JDetector.hh.

524 {
525 using namespace std;
526 using namespace JPP;
527
528 if (getDetectorVersion(this->getVersion()) < V3 || this->comment.empty()) {
529 THROW(JIOException, "Version " << getDetectorVersion(this->getVersion()) << " < " << V3 << " or missing comments.");
530 }
531
532 this->setVersion();
533
534 if (getDetectorVersion(this->getVersion()) >= V3) {
535
536 for (JComment::const_iterator i = this->comment.begin(); i != this->comment.end(); ++i) {
537
538 for (size_t i = 0; i != LENGTH_START_OF_COMMENT; ++i) {
540 }
541
542 out << *i;
543 }
544 }
545
546 const int number_of_modules = this->size();
547
548 out << static_cast<const JDetectorID&> (*this);
549 out << static_cast<const JDetectorVersion&>(*this);
550 out << static_cast<const JDetectorHeader&> (*this);
551 out << number_of_modules;
552
553 for (const_iterator module = this->begin(); module != this->end(); ++module) {
554 out << *module;
555 }
556
557 return out;
558 }

◆ getStartOfComment()

static start_of_comment_type JDETECTOR::JDetector::getStartOfComment ( )
inlinestatic

Get option for short start of comment in binary I/O.

Returns
option

Definition at line 578 of file JDetector.hh.

579 {
580 return get_start_of_comment();
581 }
static start_of_comment_type & get_start_of_comment()
Get option for short start of comment in binary I/O.
Definition JDetector.hh:612

◆ setStartOfComment()

static void JDETECTOR::JDetector::setStartOfComment ( const start_of_comment_type option)
inlinestatic

Set option for short start of comment in binary I/O.

Parameters
optionoption

Definition at line 589 of file JDetector.hh.

590 {
591 get_start_of_comment() = option;
592 }

◆ setVersion() [3/4]

void JDETECTOR::JDetector::setVersion ( ) const
inlineprotected

Set version.

This method should be called to set up the handling of detector version specific module and PMT I/O.

Definition at line 600 of file JDetector.hh.

601 {
603 JPMT ::setVersion(this->getVersion());
604 }
static void setVersion(const JVersion &version)
Set detector version.
Definition JModule.hh:130

◆ get_start_of_comment()

static start_of_comment_type & JDETECTOR::JDetector::get_start_of_comment ( )
inlinestaticprotected

Get option for short start of comment in binary I/O.

Returns
option

Definition at line 612 of file JDetector.hh.

613 {
614 static start_of_comment_type start_of_comment = NEW_START_OF_COMMENT;
615
616 return start_of_comment;
617 }
start_of_comment_type
Enumeration for different lengths of start of comment in binary I/O.
Definition JDetector.hh:567

◆ getID() [1/2]

int JLANG::JObjectID::getID ( ) const
inlineinherited

Get identifier.

Returns
identifier

Definition at line 50 of file JObjectID.hh.

51 {
52 return __id;
53 }

◆ getID() [2/2]

int & JLANG::JObjectID::getID ( )
inlineinherited

Get identifier.

Returns
identifier

Definition at line 61 of file JObjectID.hh.

62 {
63 return __id;
64 }

◆ setID()

void JLANG::JObjectID::setID ( const int id)
inlineinherited

Set identifier.

Parameters
ididentifier

Definition at line 72 of file JObjectID.hh.

73 {
74 this->__id = id;
75 }

◆ less() [1/3]

bool JLANG::JObjectID::less ( const JObjectID & object) const
inlineinherited

Less than method.

Parameters
objectobject identifier
Returns
true if this identifier less than given identifier; else false

Definition at line 84 of file JObjectID.hh.

85 {
86 return this->getID() < object.getID();
87 }
int getID() const
Get identifier.
Definition JObjectID.hh:50

◆ less() [2/3]

bool JLANG::JObjectID::less ( const int id) const
inlineinherited

Less than method.

Parameters
ididentifier
Returns
true if this identifier less than given identifier; else false

Definition at line 96 of file JObjectID.hh.

97 {
98 return this->getID() < id;
99 }

◆ more()

bool JLANG::JObjectID::more ( const int id) const
inlineinherited

More than method.

Parameters
ididentifier
Returns
true if this identifier greater than given identifier; else false

Definition at line 108 of file JObjectID.hh.

109 {
110 return this->getID() > id;
111 }

◆ hasVersion()

bool JDETECTOR::JDetectorVersion::hasVersion ( ) const
inlineinherited

Check validity of version.

Returns
true if valid; else false

Definition at line 80 of file JDetectorVersion.hh.

81 {
82 return (!this->version.empty() && (this->version[0] == 'v' || this->version[0] == 'V'));
83 }

◆ getVersion()

const std::string & JDETECTOR::JVersion::getVersion ( ) const
inlineinherited

Get version.

Returns
version

Definition at line 50 of file JDetector/JVersion.hh.

51 {
52 return this->version;
53 }

◆ setVersion() [4/4]

void JDETECTOR::JVersion::setVersion ( const std::string & version)
inlineinherited

Set version.

Parameters
versionversion

Definition at line 61 of file JDetector/JVersion.hh.

62 {
63 this->version = version;
64 }

◆ less() [3/3]

bool JDETECTOR::JVersion::less ( const JVersion & version) const
inlineinherited

Less-than method.

Parameters
versionversion
Returns
true if this version less than given version; else false

Definition at line 73 of file JDetector/JVersion.hh.

74 {
75 return this->getVersion() < version.getVersion();
76 }

◆ getDetectorHeader()

const JDetectorHeader & JDETECTOR::JDetectorHeader::getDetectorHeader ( ) const
inlineinherited

Get detector header.

Returns
header

Definition at line 76 of file JDetectorHeader.hh.

77 {
78 return static_cast<const JDetectorHeader&>(*this);
79 }

◆ equals() [1/3]

bool JDETECTOR::JDetectorHeader::equals ( const JDetectorHeader & header,
const double precision = std::numeric_limits<double>::min() ) const
inlineinherited

Check equality.

Parameters
headerheader
precisionprecision
Returns
true if headers are equal; else false

Definition at line 89 of file JDetectorHeader.hh.

91 {
92 return (this->getUTMGrid() == header.getUTMGrid() && this->getDisplacement(header.getUTMPosition()) < precision);
93 }
const JUTMGrid & getUTMGrid() const
Get UTM grid.
Definition JUTMGrid.hh:73

◆ equals() [2/3]

template<class T , class JComparator_t = std::less<T>>
bool JTOOLS::JRange< T, JComparator_t >::equals ( const range_type & range) const
inlineinherited

Equal method.

Parameters
rangerange
Returns
true if this range is equal to given range; else false

Definition at line 275 of file JRange.hh.

276 {
277 return (!this->compare(this->getLowerLimit(), range.getLowerLimit()) &&
278 !this->compare(range.getLowerLimit(), this->getLowerLimit()) &&
279 !this->compare(this->getUpperLimit(), range.getUpperLimit()) &&
280 !this->compare(range.getUpperLimit(), this->getUpperLimit()));
281 }
T getLowerLimit() const
Get lower limit.
Definition JRange.hh:202
JComparator_t compare
Function object for comparisons.
Definition JRange.hh:565

◆ equals() [3/3]

bool JUTM::JUTMGrid::equals ( const JUTMGrid & grid) const
inlineinherited

Check equality.

Parameters
gridUTM grid
Returns
true if grids are equal; else false

Definition at line 151 of file JUTMGrid.hh.

152 {
153 return (this->getKey() == grid.getKey() &&
154 this->getWGS() == grid.getWGS() &&
155 this->getUTMValue() == grid.getUTMValue());
156 }
const std::string & getKey() const
Get key.
Definition JUTMGrid.hh:95

◆ getEquationParameters()

static JEquationParameters & JDETECTOR::JDetectorHeader::getEquationParameters ( )
inlinestaticinherited

Get equation parameters.

Returns
equation parameters

Definition at line 173 of file JDetectorHeader.hh.

174 {
175 static JEquationParameters equation;
176
177 return equation;
178 }
Simple data structure to support I/O of equations (see class JLANG::JEquation).

◆ setEquationParameters()

static void JDETECTOR::JDetectorHeader::setEquationParameters ( const JEquationParameters & equation)
inlinestaticinherited

Set equation parameters.

Parameters
equationequation parameters

Definition at line 187 of file JDetectorHeader.hh.

188 {
189 getEquationParameters() = equation;
190 }
static JEquationParameters & getEquationParameters()
Get equation parameters.

◆ getProperties() [1/2]

JProperties JDETECTOR::JDetectorHeader::getProperties ( const JEquationParameters & equation = JDetectorHeader::getEquationParameters())
inlineinherited

Get properties of this class.

Parameters
equationequation parameters

Definition at line 198 of file JDetectorHeader.hh.

199 {
200 return JDetectorHeaderHelper(*this, equation);
201 }

◆ getProperties() [2/2]

JProperties JDETECTOR::JDetectorHeader::getProperties ( const JEquationParameters & equation = JDetectorHeader::getEquationParameters()) const
inlineinherited

Get properties of this class.

Parameters
equationequation parameters

Definition at line 209 of file JDetectorHeader.hh.

210 {
211 return JDetectorHeaderHelper(*this, equation);
212 }

◆ getUTCTimeRange() [1/2]

const JUTCTimeRange & JUTC::JUTCTimeRange::getUTCTimeRange ( ) const
inlineinherited

Get UTC time range.

Returns
UTC time range

Definition at line 63 of file JUTCTimeRange.hh.

64 {
65 return static_cast<const JUTCTimeRange&>(*this);
66 }
JUTCTimeRange()
Default constructor.

◆ getUTCTimeRange() [2/2]

JUTCTimeRange & JUTC::JUTCTimeRange::getUTCTimeRange ( )
inlineinherited

Get UTC time range.

Returns
UTC time range

Definition at line 74 of file JUTCTimeRange.hh.

75 {
76 return static_cast<JUTCTimeRange&>(*this);
77 }

◆ setUTCTimeRange()

void JUTC::JUTCTimeRange::setUTCTimeRange ( const JRange< double > & timerange)
inlineinherited

Set UTC time range.

Parameters
timerangeUTC time range

Definition at line 85 of file JUTCTimeRange.hh.

86 {
87 static_cast<JUTCTimeRange&>(*this) = timerange;
88 }

◆ operator pair_type()

template<class T , class JComparator_t = std::less<T>>
JTOOLS::JRange< T, JComparator_t >::operator pair_type ( ) const
inlineinherited

Type conversion operator.

Returns
piar

Definition at line 124 of file JRange.hh.

125 {
127 }
std::pair< T, T > pair_type
Definition JRange.hh:45
T getUpperLimit() const
Get upper limit.
Definition JRange.hh:213

◆ getRange()

template<class T , class JComparator_t = std::less<T>>
const range_type & JTOOLS::JRange< T, JComparator_t >::getRange ( ) const
inlineinherited

Get range.

Returns
range

Definition at line 135 of file JRange.hh.

136 {
137 return static_cast<const range_type&>(*this);
138 }
JRange< T, JComparator_t > range_type
Definition JRange.hh:46

◆ setRange() [1/6]

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::setRange ( const range_type & range)
inlineinherited

Set range.

Parameters
rangerange

Definition at line 146 of file JRange.hh.

147 {
148 static_cast<range_type&>(*this) = range;
149 }

◆ setRange() [2/6]

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::setRange ( argument_type x,
argument_type y )
inlineinherited

Set lower and upper limit.

Parameters
xlower limit
yupper limit

Definition at line 158 of file JRange.hh.

◆ setRange() [3/6]

template<class T , class JComparator_t = std::less<T>>
template<class R >
void JTOOLS::JRange< T, JComparator_t >::setRange ( R first,
R second )
inlineinherited

Set range.


The arguments could be values or iterators.

Parameters
firstfirst
secondsecond

Definition at line 173 of file JRange.hh.

174 {
175 using namespace JLANG;
176
178 }
void setRange(const range_type &range)
Set range.
Definition JRange.hh:146
Auxiliary classes and methods for language specific functionality.
Auxiliary template class for type bool.
Definition JBool.hh:21
Data structure to check whether given data type is an iterator.
Definition JClass.hh:62

◆ setRange() [4/6]

template<class T , class JComparator_t = std::less<T>>
template<class JElement_t , class JAllocator_t >
void JTOOLS::JRange< T, JComparator_t >::setRange ( const array_type< JElement_t, JAllocator_t > & buffer)
inlineinherited

Set lower and upper limit according to input data.

Parameters
bufferinput data

Definition at line 187 of file JRange.hh.

188 {
190
191 for (typename array_type<JElement_t, JAllocator_t>::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
192 include(*i);
193 }
194 }
range_type & include(argument_type x)
Include given value to range.
Definition JRange.hh:397
static T getMaximum()
Get maximum possible value.
Definition JRange.hh:545
static T getMinimum()
Get minimum possible value.
Definition JRange.hh:534

◆ setRange() [5/6]

template<class T , class JComparator_t = std::less<T>>
template<class R >
void JTOOLS::JRange< T, JComparator_t >::setRange ( R first,
R second,
const JLANG::JBool< false > & option )
inlineprotectedinherited

Set range.

Parameters
firstfirst
secondsecond
optionfalse

Definition at line 576 of file JRange.hh.

577 {
579 }
JLANG::JClass< T >::argument_type argument_type
Definition JRange.hh:47

◆ setRange() [6/6]

template<class T , class JComparator_t = std::less<T>>
template<class R >
void JTOOLS::JRange< T, JComparator_t >::setRange ( R first,
R second,
const JLANG::JBool< true > & option )
inlineprotectedinherited

Set range.

Parameters
firstfirst
secondsecond
optiontrue

Definition at line 590 of file JRange.hh.

591 {
593
594 for (R i = first; i != second; ++i) {
595 include(*i);
596 }
597 }

◆ getLowerLimit()

template<class T , class JComparator_t = std::less<T>>
T JTOOLS::JRange< T, JComparator_t >::getLowerLimit ( ) const
inlineinherited

Get lower limit.

Returns
lower limit

Definition at line 202 of file JRange.hh.

203 {
204 return this->first;
205 }

◆ getUpperLimit()

template<class T , class JComparator_t = std::less<T>>
T JTOOLS::JRange< T, JComparator_t >::getUpperLimit ( ) const
inlineinherited

Get upper limit.

Returns
upper limit

Definition at line 213 of file JRange.hh.

214 {
215 return this->second;
216 }

◆ setLowerLimit()

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::setLowerLimit ( argument_type x)
inlineinherited

Set lower limit.

Parameters
xlower limit

Definition at line 224 of file JRange.hh.

225 {
226 this->first = x;
227 }

◆ setUpperLimit()

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::setUpperLimit ( argument_type y)
inlineinherited

Set upper limit.

Parameters
yupper limit

Definition at line 235 of file JRange.hh.

236 {
237 this->second = y;
238 }

◆ fixLowerLimit()

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::fixLowerLimit ( argument_type x)
inlineinherited

Fix lower limit.

The range is shifted to the given lower limit.

Parameters
xlower limit

Definition at line 248 of file JRange.hh.

249 {
250 this->second += x - this->first;
251 this->first = x;
252 }

◆ fixUpperLimit()

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::fixUpperLimit ( argument_type y)
inlineinherited

Fix upper limit.

The range is shifted to the given upper limit.

Parameters
yupper limit

Definition at line 262 of file JRange.hh.

263 {
264 this->first += y - this->second;
265 this->second = y;
266 }

◆ getLength()

template<class T , class JComparator_t = std::less<T>>
T JTOOLS::JRange< T, JComparator_t >::getLength ( ) const
inlineinherited

Get length (difference between upper and lower limit).

Returns
length

Definition at line 289 of file JRange.hh.

290 {
291 return getUpperLimit() - getLowerLimit();
292 }

◆ setLength()

template<class T , class JComparator_t = std::less<T>>
void JTOOLS::JRange< T, JComparator_t >::setLength ( argument_type length)
inlineinherited

Set length (difference between upper and lower limit).

Parameters
lengthlength

Definition at line 300 of file JRange.hh.

301 {
302 setUpperLimit(getLowerLimit() + length);
303 }
void setUpperLimit(argument_type y)
Set upper limit.
Definition JRange.hh:235

◆ is_valid()

template<class T , class JComparator_t = std::less<T>>
bool JTOOLS::JRange< T, JComparator_t >::is_valid ( ) const
inlineinherited

Check validity of range.

Returns
true if lower limit less than or equal to upper limit; else false

Definition at line 311 of file JRange.hh.

312 {
313 return !compare(getUpperLimit(), getLowerLimit());
314 }

◆ in_range()

template<class T , class JComparator_t = std::less<T>>
bool JTOOLS::JRange< T, JComparator_t >::in_range ( argument_type x) const
inlineinherited

Test whether value is inside range.

Parameters
xvalue
Returns
true if lower limit <= value <= upper limit; else false

Definition at line 323 of file JRange.hh.

324 {
325 return (!compare(x, getLowerLimit()) &&
326 !compare(getUpperLimit(), x));
327 }

◆ operator()()

template<class T , class JComparator_t = std::less<T>>
bool JTOOLS::JRange< T, JComparator_t >::operator() ( argument_type x) const
inlineinherited

Test whether value is inside range.

Parameters
xvalue
Returns
true if lower limit <= value <= upper limit; else false

Definition at line 336 of file JRange.hh.

337 {
338 return in_range(x);
339 }
bool in_range(argument_type x) const
Test whether value is inside range.
Definition JRange.hh:323

◆ constrain()

template<class T , class JComparator_t = std::less<T>>
T JTOOLS::JRange< T, JComparator_t >::constrain ( argument_type x) const
inlineinherited

Constrain value to range.


This method returns the original value if it is in this range, else lower limit if value < lower limit or upper limit if value > upper limit.

Parameters
xvalue
Returns
lower limit <= x <= upper limit

Definition at line 350 of file JRange.hh.

351 {
352 if (compare(x, getLowerLimit())) { return getLowerLimit(); }
353 if (compare(getUpperLimit(), x)) { return getUpperLimit(); }
354
355 return x;
356 }

◆ mod()

template<class T , class JComparator_t = std::less<T>>
T JTOOLS::JRange< T, JComparator_t >::mod ( argument_type x) const
inlineinherited

Modulo value with respect to range.


Parameters
xvalue
Returns
lower limit <= x <= upper limit

Definition at line 365 of file JRange.hh.

366 {
367 if (compare(x, getLowerLimit()))
368 return x + getLength() * floor((getUpperLimit() - x) / getLength());
369 else if (compare(getUpperLimit(), x))
370 return x - getLength() * floor((x - getLowerLimit()) / getLength());
371 else
372 return x;
373 }
T getLength() const
Get length (difference between upper and lower limit).
Definition JRange.hh:289

◆ overlap()

template<class T , class JComparator_t = std::less<T>>
bool JTOOLS::JRange< T, JComparator_t >::overlap ( const range_type & range) const
inlineinherited

Test overlap with given range.


Parameters
rangerange
Returns
true if there is a non-zero overlap; else false

Definition at line 382 of file JRange.hh.

383 {
384 return (!compare(range.getUpperLimit(), getLowerLimit()) &&
385 !compare(getUpperLimit(), range.getLowerLimit()));
386 }

◆ include()

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::include ( argument_type x)
inlineinherited

Include given value to range.


The new lower limit is the minimim of the original lower limit and given value and
the new upper limit is the maximum of the original upper limit and given value;

Parameters
xvalue
Returns
range

Definition at line 397 of file JRange.hh.

398 {
399 if (compare(x, getLowerLimit())) { setLowerLimit(x); }
400 if (compare(getUpperLimit(), x)) { setUpperLimit(x); }
401
402 return *this;
403 }
void setLowerLimit(argument_type x)
Set lower limit.
Definition JRange.hh:224

◆ join()

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::join ( const range_type & range)
inlineinherited

Join ranges.


The new lower limit is the maximim of the two lower limits and
the new upper limit is the minimum of the two upper limits.
This operation results in an equal or smaller range and may result in an unphysical range (i.e. lower limit > upper limit).

Parameters
rangerange

Definition at line 415 of file JRange.hh.

416 {
417 if (compare(getLowerLimit(), range.getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
418 if (compare(range.getUpperLimit(), getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
419
420 return *this;
421 }

◆ combine()

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::combine ( const range_type & range)
inlineinherited

Combine ranges.


The new lower limit is the minimim of the two lower limits and
the new upper limit is the maximum of the two upper limits.
This operation results in an equal or larger range.

Parameters
rangerange

Definition at line 432 of file JRange.hh.

433 {
434 if (compare(range.getLowerLimit(), getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
435 if (compare(getUpperLimit(), range.getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
436
437 return *this;
438 }

◆ add() [1/3]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::add ( argument_type x)
inlineinherited

Add offset.

Parameters
xoffset

Definition at line 446 of file JRange.hh.

447 {
448 this->first += x;
449 this->second += x;
450
451 return *this;
452 }

◆ add() [2/3]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::add ( const range_type & range)
inlineinherited

Add offsets.


The new lower limit is the sum of the two lower limits and
the new upper limit is the sum of the two upper limits.

Parameters
rangeoffset

Definition at line 476 of file JRange.hh.

477 {
478 this->first += range.getLowerLimit();
479 this->second += range.getUpperLimit();
480
481 return *this;
482 }

◆ add() [3/3]

JUTMPosition & JUTM::JUTMPosition::add ( const JUTMPosition & pos)
inlineinherited

Add UTM position.

Parameters
posUTM position
Returns
this UTM position

Definition at line 210 of file JUTMPosition.hh.

211 {
212 east += pos.getUTMEast();
213 north += pos.getUTMNorth();
214 z += pos.getUTMZ();
215
216 return *this;
217 }

◆ sub() [1/3]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::sub ( argument_type x)
inlineinherited

Subtract offset.

Parameters
xoffset

Definition at line 460 of file JRange.hh.

461 {
462 this->first -= x;
463 this->second -= x;
464
465 return *this;
466 }

◆ sub() [2/3]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::sub ( const range_type & range)
inlineinherited

Subtract offsets.


The new lower limit is the difference of the two lower limits and
the new upper limit is the difference of the two upper limits.

Parameters
rangeoffset

Definition at line 492 of file JRange.hh.

493 {
494 this->first -= range.getLowerLimit();
495 this->second -= range.getUpperLimit();
496
497 return *this;
498 }

◆ sub() [3/3]

JUTMPosition & JUTM::JUTMPosition::sub ( const JUTMPosition & pos)
inlineinherited

Subtract UTM position.

Parameters
posUTM position
Returns
this UTM position

Definition at line 226 of file JUTMPosition.hh.

227 {
228 east -= pos.getUTMEast();
229 north -= pos.getUTMNorth();
230 z -= pos.getUTMZ();
231
232 return *this;
233 }

◆ mul() [1/4]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::mul ( const double factor)
inlineinherited

Multiply range.

Parameters
factorfactor

Definition at line 506 of file JRange.hh.

507 {
508 this->first *= factor;
509 this->second *= factor;
510
511 return *this;
512 }

◆ mul() [2/4]

template<class JFirst_t , class JSecond_t >
JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

355 {
356 return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
357 }

◆ mul() [3/4]

JUTMPosition & JUTM::JUTMPosition::mul ( const double factor)
inlineinherited

Scale UTM position.

Parameters
factormultiplication factor
Returns
this UTM position

Definition at line 242 of file JUTMPosition.hh.

243 {
244 east *= factor;
245 north *= factor;
246 z *= factor;
247
248 return *this;
249 }

◆ mul() [4/4]

template<class JFirst_t , class JSecond_t >
JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

355 {
356 return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
357 }

◆ div() [1/2]

template<class T , class JComparator_t = std::less<T>>
range_type & JTOOLS::JRange< T, JComparator_t >::div ( const double factor)
inlineinherited

Divide range.

Parameters
factorfactor

Definition at line 520 of file JRange.hh.

521 {
522 this->first /= factor;
523 this->second /= factor;
524
525 return *this;
526 }

◆ div() [2/2]

JUTMPosition & JUTM::JUTMPosition::div ( const double factor)
inlineinherited

Scale UTM position.

Parameters
factordivision factor
Returns
this UTM position

Definition at line 258 of file JUTMPosition.hh.

259 {
260 east /= factor;
261 north /= factor;
262 z /= factor;
263
264 return *this;
265 }

◆ getMinimum()

template<class T , class JComparator_t = std::less<T>>
static T JTOOLS::JRange< T, JComparator_t >::getMinimum ( )
inlinestaticinherited

Get minimum possible value.

Returns
minimum possible value

Definition at line 534 of file JRange.hh.

535 {
536 return JMATH::JLimits<T>::min();
537 }
float min()
Get minimum possible value.
Definition JLimits.hh:96

◆ getMaximum()

template<class T , class JComparator_t = std::less<T>>
static T JTOOLS::JRange< T, JComparator_t >::getMaximum ( )
inlinestaticinherited

Get maximum possible value.

Returns
maximum possible value

Definition at line 545 of file JRange.hh.

546 {
547 return JMATH::JLimits<T>::max();
548 }
TTimeStamp max()
Get maximum possible value.

◆ DEFAULT_RANGE()

template<class T , class JComparator_t = std::less<T>>
static JRange< T, JComparator_t > JTOOLS::JRange< T, JComparator_t >::DEFAULT_RANGE ( )
inlinestaticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 555 of file JRange.hh.

◆ getKey() [1/2]

const key_type & JTOOLS::JPair< T, T >::getKey ( ) const
inlineinherited

Definition at line 123 of file JPair.hh.

123{ return this->first; }

◆ getKey() [2/2]

const std::string & JUTM::JUTMGrid::getKey ( ) const
inlineinherited

Get key.

Returns
key

Definition at line 95 of file JUTMGrid.hh.

96 {
97 return key;
98 }
std::string key
Definition JUTMGrid.hh:246

◆ getValue() [1/2]

const mapped_type & JTOOLS::JPair< T, T >::getValue ( ) const
inlineinherited

Definition at line 124 of file JPair.hh.

124{ return this->second; }

◆ getValue() [2/2]

mapped_type & JTOOLS::JPair< T, T >::getValue ( )
inlineinherited

Definition at line 126 of file JPair.hh.

126{ return this->second; }

◆ getUTMGrid()

const JUTMGrid & JUTM::JUTMGrid::getUTMGrid ( ) const
inlineinherited

Get UTM grid.

Returns
UTM grid

Definition at line 73 of file JUTMGrid.hh.

74 {
75 return static_cast<const JUTMGrid&>(*this);
76 }
JUTMGrid()
Default constructor.
Definition JUTMGrid.hh:44

◆ setUTMGrid()

void JUTM::JUTMGrid::setUTMGrid ( const JUTMGrid & grid)
inlineinherited

Set UTM grid.

Parameters
gridUTM grid

Definition at line 84 of file JUTMGrid.hh.

85 {
86 static_cast<JUTMGrid&>(*this) = grid;
87 }

◆ getWGS()

const std::string & JUTM::JUTMGrid::getWGS ( ) const
inlineinherited

Get WGS.

Returns
WGS

Definition at line 106 of file JUTMGrid.hh.

107 {
108 return wgs;
109 }
std::string wgs
Definition JUTMGrid.hh:247

◆ getUTMZone()

const std::string & JUTM::JUTMGrid::getUTMZone ( ) const
inlineinherited

Get UTM zone.

Returns
UTM zone

Definition at line 117 of file JUTMGrid.hh.

118 {
119 return zone;
120 }
std::string zone
Definition JUTMGrid.hh:248

◆ getUTMValue()

int JUTM::JUTMGrid::getUTMValue ( ) const
inlineinherited

Get UTM zone by numerical value.

Returns
UTM zone

Definition at line 128 of file JUTMGrid.hh.

129 {
130 using namespace std;
131
132 int value = 0;
133
134 for (string::const_iterator i = zone.begin(); i != zone.end(); ++i) {
135 if (isdigit(*i))
136 value = 10 * value + (*i - '0');
137 else
138 break;
139 }
140
141 return value;
142 }

◆ toString()

std::string JUTM::JUTMGrid::toString ( ) const
inlineinherited

Convert UTM grid.

Returns
UTM grid

Definition at line 164 of file JUTMGrid.hh.

165 {
166 return (key + " " + wgs + " " + zone);
167 }

◆ valueOf()

static JUTMGrid JUTM::JUTMGrid::valueOf ( const std::string & buffer)
inlinestaticinherited

Extract UTM grid.

Parameters
bufferWGS and UTM zone
Returns
UTM grid

Definition at line 176 of file JUTMGrid.hh.

177 {
178 JUTMGrid grid;
179
180 std::istringstream is(buffer);
181
182 if (is >> grid)
183 return grid;
184 else
185 throw JParseError("JUTMGrid::valueOf()");
186 }

◆ getUTMPosition()

const JUTMPosition & JUTM::JUTMPosition::getUTMPosition ( ) const
inlineinherited

Get UTM position.

Returns
position

Definition at line 84 of file JUTMPosition.hh.

85 {
86 return static_cast<const JUTMPosition&>(*this);
87 }
JUTMPosition()
Default constructor.

◆ setUTMPosition()

void JUTM::JUTMPosition::setUTMPosition ( const JUTMPosition & position)
inlineinherited

Set UTM position.

Parameters
positionposition

Definition at line 95 of file JUTMPosition.hh.

96 {
97 static_cast<JUTMPosition&>(*this) = position;
98 }

◆ getPosition()

JPosition3D JUTM::JUTMPosition::getPosition ( ) const
inlineinherited

Get position.

Returns
position

Definition at line 106 of file JUTMPosition.hh.

107 {
108 return JPosition3D(this->getX(), this->getY(), this->getZ());
109 }
double getZ() const
Get z.
double getY() const
Get y.
double getX() const
Get x.

◆ operator JPosition3D()

JUTM::JUTMPosition::operator JPosition3D ( ) const
inlineinherited

Type conversion operator.

Returns
position

Definition at line 117 of file JUTMPosition.hh.

118 {
119 return getPosition();
120 }
JPosition3D getPosition() const
Get position.

◆ getUTMEast()

double JUTM::JUTMPosition::getUTMEast ( ) const
inlineinherited

Get UTM east.

Returns
UTM East

Definition at line 128 of file JUTMPosition.hh.

129 {
130 return this->east;
131 }

◆ getUTMNorth()

double JUTM::JUTMPosition::getUTMNorth ( ) const
inlineinherited

Get UTM north.

Returns
UTM North

Definition at line 139 of file JUTMPosition.hh.

140 {
141 return this->north;
142 }

◆ getUTMZ()

double JUTM::JUTMPosition::getUTMZ ( ) const
inlineinherited

Get UTM Z.

Returns
UTM Z

Definition at line 150 of file JUTMPosition.hh.

151 {
152 return this->z;
153 }

◆ getX()

double JUTM::JUTMPosition::getX ( ) const
inlineinherited

Get x.

Returns
UTM East

Definition at line 161 of file JUTMPosition.hh.

162 {
163 return this->east;
164 }

◆ getY()

double JUTM::JUTMPosition::getY ( ) const
inlineinherited

Get y.

Returns
UTM North

Definition at line 172 of file JUTMPosition.hh.

173 {
174 return this->north;
175 }

◆ getZ()

double JUTM::JUTMPosition::getZ ( ) const
inlineinherited

Get z.

Returns
UTM Z

Definition at line 183 of file JUTMPosition.hh.

184 {
185 return this->z;
186 }

◆ negate()

JUTMPosition & JUTM::JUTMPosition::negate ( )
inlineinherited

Negate UTM position.

Returns
this UTM position

Definition at line 194 of file JUTMPosition.hh.

195 {
196 east = -east;
197 north = -north;
198 z = -z;
199
200 return *this;
201 }

◆ getDisplacement()

double JUTM::JUTMPosition::getDisplacement ( const JUTMPosition & position) const
inlineinherited

Get displacement to position.

The displacement corresponds to the 2D distance in the (East,North) plane.

Parameters
positionposition
Returns
displacement

Definition at line 276 of file JUTMPosition.hh.

277 {
278 const double x = this->getUTMEast() - position.getUTMEast();
279 const double y = this->getUTMNorth() - position.getUTMNorth();
280
281 return sqrt(x*x + y*y);
282 }
double getUTMNorth() const
Get UTM north.
double getUTMEast() const
Get UTM east.

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>> ( std::istream & in,
JDetector & detector )
friend

Read detector from input.

Parameters
ininput stream
detectordetector
Returns
input stream

Definition at line 373 of file JDetector.hh.

374 {
375 using namespace std;
376
377 detector.clear();
378
379 string buffer;
380
381 if (in
382 >> detector.comment
383 >> static_cast<JDetectorID&>(detector)
384 >> buffer) {
385
386 int number_of_modules;
387 int version = -1;
388
389 try {
390 version = getDetectorVersion(buffer);
391 }
392 catch(std::exception&) {}
393
394 switch (version) {
395
396 default:
397 in >> static_cast<JDetectorHeader&>(detector);
398
399 case V1:
400 in >> number_of_modules;
401 detector.setVersion(buffer);
402 break;
403
404 case -1:
405 detector.setVersion(putDetectorVersion(V1));
406 istringstream(buffer) >> number_of_modules;
407 break;
408 }
409
410 for (JModule module; number_of_modules != 0 && in >> module; --number_of_modules) {
411 detector.push_back(module);
412 }
413 }
414
415 return in;
416 }

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JDetector & detector )
friend

Write detector to output.

Parameters
outoutput stream
detectordetector
Returns
output stream

Definition at line 426 of file JDetector.hh.

427 {
428 using namespace std;
429 using namespace JPP;
430
431 detector.setVersion();
432
433 setFormat<JPosition3D> (JFormat_t( 9, 3, std::ios::fixed | std::ios::showpos));
434 setFormat<JDirection3D> (JFormat_t( 9, 6, std::ios::fixed | std::ios::showpos));
435 setFormat<JQuaternion3D>(JFormat_t( 9, 6, std::ios::fixed | std::ios::showpos));
436 setFormat<JCalibration> (JFormat_t(10, 3, std::ios::fixed | std::ios::showpos));
437
438 if (getDetectorVersion(detector.getVersion()) >= V3) {
439 out << detector.comment;
440 }
441
442 out << static_cast<const JDetectorID&>(detector);
443
444 switch (getDetectorVersion(detector.getVersion())) {
445
446 default:
447 out << " ";
448 out << static_cast<const JDetectorVersion&>(detector) << endl;
449 out << static_cast<const JDetectorHeader&> (detector) << endl;
450 break;
451
452 case V1:
453 out << " ";
454 break;
455 }
456
457 out << detector.size() << endl;
458
459 for (const_iterator i = detector.begin(); i != detector.end(); ++i) {
460 out << *i << endl;
461 }
462
463 return out;
464 }
void setFormat(const JFormat_t &format)
Set format for given type.
Definition JManip.hh:714
Detector file.
Definition JHead.hh:227
Data structure for format specifications.
Definition JManip.hh:524

Member Data Documentation

◆ comment

JComment JDETECTOR::JDetector::comment

Definition at line 561 of file JDetector.hh.

◆ LENGTH_START_OF_COMMENT

const size_t JDETECTOR::JDetector::LENGTH_START_OF_COMMENT = sizeof(JDetectorID)
staticprotected

Length of start of comment in binary I/O.

Definition at line 623 of file JDetector.hh.

◆ __id

int JLANG::JObjectID::__id
protectedinherited

Definition at line 140 of file JObjectID.hh.

◆ version

std::string JDETECTOR::JVersion::version
protectedinherited

Definition at line 79 of file JDetector/JVersion.hh.

◆ compare

template<class T , class JComparator_t = std::less<T>>
JComparator_t JTOOLS::JRange< T, JComparator_t >::compare
inherited

Function object for comparisons.

Definition at line 565 of file JRange.hh.

◆ first

T JTOOLS::JPair< T, T >::first
inherited

Definition at line 128 of file JPair.hh.

◆ second

T JTOOLS::JPair< T, T >::second
inherited

Definition at line 129 of file JPair.hh.

◆ key

std::string JUTM::JUTMGrid::key
protectedinherited

Definition at line 246 of file JUTMGrid.hh.

◆ wgs

std::string JUTM::JUTMGrid::wgs
protectedinherited

Definition at line 247 of file JUTMGrid.hh.

◆ zone

std::string JUTM::JUTMGrid::zone
protectedinherited

Definition at line 248 of file JUTMGrid.hh.

◆ east

double JUTM::JUTMPosition::east
protectedinherited

Definition at line 344 of file JUTMPosition.hh.

◆ north

double JUTM::JUTMPosition::north
protectedinherited

Definition at line 345 of file JUTMPosition.hh.

◆ z

double JUTM::JUTMPosition::z
protectedinherited

Definition at line 346 of file JUTMPosition.hh.


The documentation for this class was generated from the following file: