Data structure for detector header. More...

#include <JDetectorHeader.hh>

Inheritance diagram for JDETECTOR::JDetectorHeader:

Classes
class	JDetectorHeaderHelper
	Auxiliary class for I/O of detector header. More...

Public Types
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
	JDetectorHeader ()
	Default constructor. More...

	JDetectorHeader (const JUTCTimeRange &range, const JUTMGrid &grid, const JUTMPosition &pos)
	Constructor. More...

JProperties	getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters())
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &equation=JDetectorHeader::getEquationParameters()) const
	Get properties of this class. More...

const range_type &	getRange () const
	Get range. More...

void	setRange (const range_type &range)
	Set range. More...

void	setRange (argument_type x, argument_type y)
	Set lower and upper limit. More...

template<class R >
void	setRange (R first, R second)
	Set range. More...

template<class iterator_type , class value_type , class result_type >
void	setRange (iterator_type __begin, iterator_type __end, result_type value_type::*member)
	Set lower and upper limit according to minimal and maximal value in input data, respectively. More...

template<class iterator_type , class value_type , class result_type >
void	setRange (iterator_type __begin, iterator_type __end, result_type(value_type::*function)() const)
	Set lower and upper limit according to minimal and maximal value in input data, respectively. More...

T	getLowerLimit () const
	Get lower limit. More...

T	getUpperLimit () const
	Get upper limit. More...

void	setLowerLimit (argument_type x)
	Set lower limit. More...

void	setUpperLimit (argument_type y)
	Set upper limit. More...

void	fixLowerLimit (argument_type x)
	Fix lower limit. More...

void	fixUpperLimit (argument_type y)
	Fix upper limit. More...

bool	equals (const range_type &range) const
	Equal method. More...

T	getLength () const
	Get length (difference between upper and lower limit). More...

bool	is_valid () const
	Check validity of range. More...

bool	operator() (argument_type x) const
	Test whether value is inside range. More...

T	constrain (argument_type x) const
	Constrain value to range. More...

T	mod (argument_type x) const
	Modulo value with respect to range. More...

bool	overlap (const range_type &range) const
	Test overlap with given range. More...

range_type	include (argument_type x)
	Include given value to range. More...

range_type &	join (const range_type &range)
	Join ranges. More...

range_type &	combine (const range_type &range)
	Combine ranges. More...

range_type &	add (argument_type x)
	Add offset. More...

range_type &	add (const range_type &range)
	Add offsets. More...

range_type &	sub (argument_type x)
	Subtract offset. More...

range_type &	sub (const range_type &range)
	Subtract offsets. More...

range_type &	mul (const double factor)
	Multiply range. More...

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

range_type &	div (const double factor)
	Divide range. More...

T	getN (const double R) const
	Get expected number of occurances of given rate within this interval. More...

const key_type &	getKey () const

const mapped_type &	getValue () const

mapped_type &	getValue ()

const std::string &	getKey () const
	Get key. More...

const std::string &	getWGS () const
	Get WGS. More...

const std::string &	getUTMZone () const
	Get UTM zone. More...

std::string	toString () const
	Convert UTM grid. More...

const JUTMPosition &	getUTMPosition () const
	Get UTM position. More...

JPosition3D	getPosition () const
	Get position. More...

double	getUTMEast () const
	Get UTM east. More...

double	getUTMNorth () const
	Get UTM north. More...

double	getUTMZ () const
	Get UTM Z. More...

JUTMPosition &	negate ()
	Negate UTM position. More...

JUTMPosition &	add (const JUTMPosition &pos)
	Add UTM position. More...

JUTMPosition &	sub (const JUTMPosition &pos)
	Subtract UTM position. More...

JUTMPosition &	mul (const double factor)
	Scale UTM position. More...

JUTMPosition &	mul (const JSecond_t &object)
	Multiply with object. More...

JUTMPosition &	div (const double factor)
	Scale UTM position. More...

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters. More...

static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters. More...

static T	getMinimum ()
	Get minimum possible value. More...

static T	getMaximum ()
	Get maximum possible value. More...

static JUTMGrid	valueOf (const std::string &buffer)
	Extract UTM grid. More...

Public Attributes
JComparator_t	compare
	Function object. More...

T	first

T	second

Static Public Attributes
static const JRange< T, JComparator_t >	DEFAULT_RANGE
	Default range. More...

Protected Member Functions
template<class R >
void	setRange (R first, R second, const JLANG::JBool< false > &option)
	Set range. More...

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

Protected Attributes
std::string	key

std::string	wgs

std::string	zone

double	east

double	north

double	z

Friends
std::istream &	operator>> (std::istream &in, JDetectorHeader &header)
	Read detector header from input. More...

std::ostream &	operator<< (std::ostream &out, const JDetectorHeader &header)
	Write detector header to output. More...

JReader &	operator>> (JReader &in, JDetectorHeader &header)
	Read detector header from input. More...

JWriter &	operator<< (JWriter &out, const JDetectorHeader &header)
	Write detector header to output. More...

Detailed Description

Data structure for detector header.

Definition at line 35 of file JDetectorHeader.hh.

Member Typedef Documentation

◆ range_type

template<class T, class JComparator_t = std::less<T>>

typedef JRange<T, JComparator_t> JTOOLS::JRange< T, JComparator_t >::range_type

inherited

Definition at line 41 of file JRange.hh.

◆ argument_type

template<class T, class JComparator_t = std::less<T>>

typedef JLANG::JClass<T>::argument_type JTOOLS::JRange< T, JComparator_t >::argument_type

inherited

Definition at line 42 of file JRange.hh.

◆ key_type

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

inherited

Definition at line 32 of file JPair.hh.

◆ mapped_type

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

inherited

Definition at line 33 of file JPair.hh.

Constructor & Destructor Documentation

◆ JDetectorHeader() [1/2]

JDETECTOR::JDetectorHeader::JDetectorHeader ( )

inline

Default constructor.

Definition at line 44 of file JDetectorHeader.hh.

                       :
       JUTCTimeRange(),
       JUTMGrid     (),
       JUTMPosition ()
     {}

◆ JDetectorHeader() [2/2]

JDETECTOR::JDetectorHeader::JDetectorHeader	(	const JUTCTimeRange &	range,
		const JUTMGrid &	grid,
		const JUTMPosition &	pos
	)

inline

Constructor.

Parameters

range	UTC time range
grid	UTM grid
pos	UTM position

Definition at line 58 of file JDetectorHeader.hh.

                                               :
       JUTCTimeRange(range),
       JUTMGrid     (grid),
       JUTMPosition (pos)
     {}

Member Function Documentation

◆ getEquationParameters()

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

inlinestatic

Get equation parameters.

Returns: equation parameters

Definition at line 144 of file JDetectorHeader.hh.

     {
       static JEquationParameters equation;
  
       return equation;
     }

◆ setEquationParameters()

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

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 158 of file JDetectorHeader.hh.

     {
       getEquationParameters() = equation;
     }

◆ getProperties() [1/2]

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

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 169 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

◆ getProperties() [2/2]

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

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 180 of file JDetectorHeader.hh.

     {
       return JDetectorHeaderHelper(*this, equation);
     }

◆ 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 128 of file JRange.hh.

     {
       return static_cast<const range_type&>(*this);
     }

◆ setRange() [1/7]

template<class T, class JComparator_t = std::less<T>>

void JTOOLS::JRange< T, JComparator_t >::setRange ( const range_type & range )

inlineinherited

Set range.

Parameters

range range

Definition at line 139 of file JRange.hh.

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

◆ setRange() [2/7]

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

x	lower limit
y	upper limit

Definition at line 151 of file JRange.hh.

     {
       this->first  = x;
       this->second = y;
     }

◆ setRange() [3/7]

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

first	first
second	second

Definition at line 166 of file JRange.hh.

     {
       using namespace JLANG;
       
       setRange(first, second, JBool<is_iterator<R>::value>());
     }

◆ setRange() [4/7]

template<class T, class JComparator_t = std::less<T>>

template<class iterator_type , class value_type , class result_type >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	iterator_type	__begin,
		iterator_type	__end,
		result_type value_type::*	member
	)

inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters

__begin	begin of data
__end	end of data
member	pointer to data member

Definition at line 182 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (iterator_type i = __begin; i != __end; ++i) {
         include((*i).*member);
       }
     }

◆ setRange() [5/7]

template<class T, class JComparator_t = std::less<T>>

template<class iterator_type , class value_type , class result_type >

void JTOOLS::JRange< T, JComparator_t >::setRange	(	iterator_type	__begin,
		iterator_type	__end,
		result_type(value_type::*)() const	function
	)

inlineinherited

Set lower and upper limit according to minimal and maximal value in input data, respectively.

Parameters

__begin	begin of data
__end	end of data
function	pointer to member method

Definition at line 200 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (iterator_type i = __begin; i != __end; ++i) {
         include(((*i).*function)());
       }
     }

◆ setRange() [6/7]

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

first	first
second	second
option	false

Definition at line 579 of file JRange.hh.

     {
       setRange((argument_type) first, (argument_type) second);
     }

◆ setRange() [7/7]

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

first	first
second	second
option	true

Definition at line 593 of file JRange.hh.

     {
       setRange(getMaximum(), getMinimum());
  
       for (R i = first; i != second; ++i) {
         include(*i);
       }
     }

◆ 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 215 of file JRange.hh.

     {
       return this->first;
     }

◆ 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 226 of file JRange.hh.

     {
       return this->second;
     }

◆ 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

x	lower limit

Definition at line 237 of file JRange.hh.

     {
       this->first  = x;
     }

◆ 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

y	upper limit

Definition at line 248 of file JRange.hh.

     {
       this->second = y;
     }

◆ 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

x	lower limit

Definition at line 261 of file JRange.hh.

     {
       this->second += x - this->first;
       this->first   = x;
     }

◆ 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

y	upper limit

Definition at line 275 of file JRange.hh.

     {
       this->first  += y - this->second;
       this->second  = y;
     }

◆ equals()

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

range range

Returns: true if this module range equal to given module range; else false

Definition at line 288 of file JRange.hh.

     {
       return (!this->compare(this->getLowerLimit(), range.getLowerLimit()) &&
               !this->compare(range.getLowerLimit(), this->getLowerLimit()) &&
               !this->compare(this->getUpperLimit(), range.getUpperLimit()) &&
               !this->compare(range.getUpperLimit(), this->getUpperLimit()));
     }

◆ 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 302 of file JRange.hh.

     {
       return getUpperLimit() - getLowerLimit();
     }

◆ 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 313 of file JRange.hh.

     {
       return !compare(getUpperLimit(), getLowerLimit());
     }

◆ 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

x value

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

Definition at line 325 of file JRange.hh.

     {
       return (!compare(x, getLowerLimit()) && 
               !compare(getUpperLimit(), x));
     }

◆ 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

x value

Returns: lower limit <= x <= upper limit

Definition at line 340 of file JRange.hh.

     {
       if (compare(x, getLowerLimit())) { return getLowerLimit(); }
       if (compare(getUpperLimit(), x)) { return getUpperLimit(); }
  
       return x;
     }

◆ 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

x value

Returns: lower limit <= x <= upper limit

Definition at line 355 of file JRange.hh.

     {
       if      (compare(x, getLowerLimit()))
         return x + getLength() * floor((getUpperLimit() - x) / getLength());
       else if (compare(getUpperLimit(), x))
         return x - getLength() * floor((x - getLowerLimit()) / getLength());
       else
         return x;
     }

◆ 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.

The result is equivalent to join(range).is_valid().

Parameters

range range

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

Definition at line 373 of file JRange.hh.

     {  
       return (compare(getLowerLimit(), range.getUpperLimit()) &&
               compare(range.getLowerLimit(), getUpperLimit()));
     }

◆ 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

x value

Returns: range

Definition at line 388 of file JRange.hh.

     {
       if (compare(x, getLowerLimit())) { setLowerLimit(x); }
       if (compare(getUpperLimit(), x)) { setUpperLimit(x); }
  
       return *this;
     }

◆ 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

range range

Definition at line 406 of file JRange.hh.

     {  
       if (compare(getLowerLimit(), range.getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
       if (compare(range.getUpperLimit(), getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
  
       return *this;      
     }

◆ 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

range range

Definition at line 423 of file JRange.hh.

     {  
       if (compare(range.getLowerLimit(), getLowerLimit())) { setLowerLimit(range.getLowerLimit()); }
       if (compare(getUpperLimit(), range.getUpperLimit())) { setUpperLimit(range.getUpperLimit()); }
  
       return *this;
     }

◆ 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

x offset

Definition at line 437 of file JRange.hh.

     { 
       this->first  += x;
       this->second += x;
  
       return *this;
     }

◆ 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

range offset

Definition at line 467 of file JRange.hh.

     { 
       this->first  += range.getLowerLimit();
       this->second += range.getUpperLimit();
  
       return *this;
     }

◆ 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

x offset

Definition at line 451 of file JRange.hh.

     { 
       this->first  -= x;
       this->second -= x;
  
       return *this;
     }

◆ 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

range offset

Definition at line 483 of file JRange.hh.

     { 
       this->first  -= range.getLowerLimit();
       this->second -= range.getUpperLimit();
  
       return *this;
     }

◆ 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

factor factor

Definition at line 497 of file JRange.hh.

     { 
       this->first  *= factor;
       this->second *= factor;
  
       return *this;
     }

◆ 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

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

◆ 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

factor factor

Definition at line 511 of file JRange.hh.

     { 
       this->first  /= factor;
       this->second /= factor;
  
       return *this;
     }

◆ getN()

template<class T, class JComparator_t = std::less<T>>

T JTOOLS::JRange< T, JComparator_t >::getN ( const double R ) const

inlineinherited

Get expected number of occurances of given rate within this interval.

Parameters

R rate

Returns: expectation value

Definition at line 526 of file JRange.hh.

     {
       return R * (getUpperLimit() - getLowerLimit());
     }

◆ 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 537 of file JRange.hh.

     { 
       return JMATH::JLimits<T>::min();
     }

◆ 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 548 of file JRange.hh.

     { 
       return JMATH::JLimits<T>::max();
     }

◆ 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; }

◆ 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; }

◆ getKey() [2/2]

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

inlineinherited

Get key.

Returns: key

Definition at line 68 of file JUTMGrid.hh.

     {
       return key;
     }

◆ getWGS()

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

inlineinherited

Get WGS.

Returns: WGS

Definition at line 79 of file JUTMGrid.hh.

     {
       return wgs;
     }

◆ getUTMZone()

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

inlineinherited

Get UTM zone.

Returns: UTM zone

Definition at line 90 of file JUTMGrid.hh.

     {
       return zone;
     }

◆ toString()

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

inlineinherited

Convert UTM grid.

Returns: UTM grid

Definition at line 101 of file JUTMGrid.hh.

     {
       return (key + " " + wgs + " " + zone);
     }

◆ valueOf()

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

inlinestaticinherited

Extract UTM grid.

Parameters

buffer WGS and UTM zone

Returns: UTM grid

Definition at line 113 of file JUTMGrid.hh.

     {
       JUTMGrid grid;
  
       std::istringstream is(buffer);
  
       if (is >> grid)
         return grid;
       else
         throw JParseError("JUTMGrid::valueOf()");
     }

◆ getUTMPosition()

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

inlineinherited

Get UTM position.

Returns: position

Definition at line 82 of file JUTMPosition.hh.

     {
       return static_cast<const JUTMPosition&>(*this);
     }

◆ getPosition()

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 93 of file JUTMPosition.hh.

     {
       return JPosition3D(east, north, z);
     }

◆ getUTMEast()

double JUTM::JUTMPosition::getUTMEast ( ) const

inlineinherited

Get UTM east.

Returns: UTM East

Definition at line 104 of file JUTMPosition.hh.

     {
       return this->east;
     }

◆ getUTMNorth()

double JUTM::JUTMPosition::getUTMNorth ( ) const

inlineinherited

Get UTM north.

Returns: UTM North

Definition at line 115 of file JUTMPosition.hh.

     {
       return this->north;
     }

◆ getUTMZ()

double JUTM::JUTMPosition::getUTMZ ( ) const

inlineinherited

Get UTM Z.

Returns: UTM Z

Definition at line 126 of file JUTMPosition.hh.

     {
       return this->z;
     }

◆ negate()

JUTMPosition& JUTM::JUTMPosition::negate ( )

inlineinherited

Negate UTM position.

Returns: this UTM position

Definition at line 137 of file JUTMPosition.hh.

     {
       east  = -east;
       north = -north;
       z     = -z;
  
       return *this;
     }

◆ add() [3/3]

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

inlineinherited

Add UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 153 of file JUTMPosition.hh.

     {
       east  += pos.getUTMEast();
       north += pos.getUTMNorth();
       z     += pos.getUTMZ();
  
       return *this;
     }

◆ sub() [3/3]

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

inlineinherited

Subtract UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 169 of file JUTMPosition.hh.

     {
       east  -= pos.getUTMEast();
       north -= pos.getUTMNorth();
       z     -= pos.getUTMZ();
  
       return *this;
     }

◆ mul() [3/4]

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

inlineinherited

Scale UTM position.

Parameters

factor multiplication factor

Returns: this UTM position

Definition at line 185 of file JUTMPosition.hh.

     {
       east  *= factor;
       north *= factor;
       z     *= factor;
  
       return *this;
     }

◆ mul() [4/4]

JUTMPosition & JMATH::JMath< JUTMPosition , JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

◆ div() [2/2]

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

inlineinherited

Scale UTM position.

Parameters

factor division factor

Returns: this UTM position

Definition at line 201 of file JUTMPosition.hh.

     {
       east  /= factor;
       north /= factor;
       z     /= factor;
  
       return *this;
     }

Friends And Related Function Documentation

◆ operator>> [1/2]

std::istream& operator>>	(	std::istream &	in,
		JDetectorHeader &	header
	)

friend

Read detector header from input.

Parameters

in	input stream
header	header

Returns: input stream

Definition at line 74 of file JDetectorHeader.hh.

     {
       in >> static_cast<JUTCTimeRange&>(header);
       in >> static_cast<JUTMGrid&>     (header);
       in >> static_cast<JUTMPosition&> (header);
  
       return in;
     }

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	out,
		const JDetectorHeader &	header
	)

friend

Write detector header to output.

Parameters

out	output stream
header	header

Returns: output stream

Definition at line 91 of file JDetectorHeader.hh.

     {
       using namespace std;
       
       out << static_cast<const JUTCTimeRange&>(header);
       out << endl;
       out << static_cast<const JUTMGrid&>     (header);
       out << ' ';
       out << static_cast<const JUTMPosition&> (header);
  
       return out;
     }

◆ operator>> [2/2]

JReader& operator>>	(	JReader &	in,
		JDetectorHeader &	header
	)

friend

Read detector header from input.

Parameters

in	input stream
header	header

Returns: input stream

Definition at line 112 of file JDetectorHeader.hh.

     {
       in >> static_cast<JUTCTimeRange&>(header);
       in >> static_cast<JUTMGrid&>     (header);
       in >> static_cast<JUTMPosition&> (header);
  
       return in;
     }

◆ operator<< [2/2]

JWriter& operator<<	(	JWriter &	out,
		const JDetectorHeader &	header
	)

friend

Write detector header to output.

Parameters

out	output stream
header	header

Returns: output stream

Definition at line 129 of file JDetectorHeader.hh.

     {
       out << static_cast<const JUTCTimeRange&>(header);
       out << static_cast<const JUTMGrid&>     (header);
       out << static_cast<const JUTMPosition&> (header);
  
       return out;
     }

Member Data Documentation

◆ DEFAULT_RANGE

template<class T, class JComparator_t = std::less<T>>

const JRange< T, JComparator_t > JTOOLS::JRange< T, JComparator_t >::DEFAULT_RANGE

staticinherited

Default range.

This range corresponds to an unphysical range.

Definition at line 558 of file JRange.hh.

◆ compare

template<class T, class JComparator_t = std::less<T>>

JComparator_t JTOOLS::JRange< T, JComparator_t >::compare

inherited

Function object.

Parameters

first	first argument
second	second argument

Returns: true if first < second; else false

Definition at line 568 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 183 of file JUTMGrid.hh.

◆ wgs

std::string JUTM::JUTMGrid::wgs

protectedinherited

Definition at line 184 of file JUTMGrid.hh.

◆ zone

std::string JUTM::JUTMGrid::zone

protectedinherited

Definition at line 185 of file JUTMGrid.hh.

◆ east

double JUTM::JUTMPosition::east

protectedinherited

Definition at line 265 of file JUTMPosition.hh.

◆ north

double JUTM::JUTMPosition::north

protectedinherited

Definition at line 266 of file JUTMPosition.hh.

◆ z

double JUTM::JUTMPosition::z

protectedinherited

Definition at line 267 of file JUTMPosition.hh.

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

JDetectorHeader.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ range_type

◆ argument_type

◆ key_type

◆ mapped_type

Constructor & Destructor Documentation

◆ JDetectorHeader() [1/2]

◆ JDetectorHeader() [2/2]

Member Function Documentation

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ getRange()

◆ setRange() [1/7]

◆ setRange() [2/7]

◆ setRange() [3/7]

◆ setRange() [4/7]

◆ setRange() [5/7]

◆ setRange() [6/7]

◆ setRange() [7/7]

◆ getLowerLimit()

◆ getUpperLimit()

◆ setLowerLimit()

◆ setUpperLimit()

◆ fixLowerLimit()

◆ fixUpperLimit()

◆ equals()

◆ getLength()

◆ is_valid()

◆ operator()()

◆ constrain()

◆ mod()

◆ overlap()

◆ include()

◆ join()

◆ combine()

◆ add() [1/3]

◆ add() [2/3]

◆ sub() [1/3]

◆ sub() [2/3]

◆ mul() [1/4]

◆ mul() [2/4]

◆ div() [1/2]

◆ getN()

◆ getMinimum()

◆ getMaximum()

◆ getKey() [1/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getKey() [2/2]

◆ getWGS()

◆ getUTMZone()

◆ toString()

◆ valueOf()

◆ getUTMPosition()

◆ getPosition()

◆ getUTMEast()

◆ getUTMNorth()

◆ getUTMZ()

◆ negate()

◆ add() [3/3]

◆ sub() [3/3]

◆ mul() [3/4]

◆ mul() [4/4]

◆ div() [2/2]

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]