Detector geometry. More...

#include <JGeometry.hh>

Inheritance diagram for JACOUSTICS::JGEOMETRY::JDetector:

Classes
struct	module_type
	Auxiliary data structure for module location and position. More...

Public Types
typedef JKey_t	key_type

typedef JValue_t	mapped_type

typedef std::pair< JKey_t, JValue_t >	value_type

typedef JHashMapEvaluator< JEvaluator_t >	evaluator_type

typedef JHashCollection< value_type, evaluator_type >	collection_type

typedef collection_type::container_type	container_type

typedef container_type::const_iterator	const_iterator

typedef container_type::const_reverse_iterator	const_reverse_iterator

typedef container_type::iterator	iterator

typedef container_type::reverse_iterator	reverse_iterator

Public Member Functions
	JDetector ()
	Default constructor. More...

	JDetector (const JDETECTOR::JDetector &detector, const std::vector< JHydrophone > &hydrophones=std::vector< JHydrophone >())
	Constructor. More...

bool	hasString (int string) const
	Check if this detector has given string. More...

bool	hasLocation (const JLocation &location) const
	Check if this detector has given location. More...

virtual void	clear () override
	Clear. More...

void	reset ()
	Reset values. More...

void	set (const JHashMap &source, const mapped_type &value)
	Set values corresponding to keys in given source. More...

virtual mapped_type &	get (typename JClass< key_type >::argument_type key) override
	Get mapped value. More...

virtual const mapped_type &	get (typename JClass< key_type >::argument_type key) const override
	Get mapped value. More...

value_type &	get (const T &value)
	Get element with given value. More...

const value_type &	get (const T &value) const
	Get element with given value. More...

void	swap (JHashCollection &collection)
	Swap hash collection. More...

const_iterator	find (const T &value) const
	Find element with given value. More...

iterator	find (const T &value)
	Find element with given value. More...

virtual bool	insert (const value_type &element)
	Insert element. More...

void	insert (T __begin, T __end)
	Insert values. More...

void	erase (iterator pos)
	Erase element at given position. More...

void	erase (iterator __begin, iterator __end)
	Erase elements in given range. More...

bool	erase (const T &value)
	Erase element with given value. More...

bool	has (const T &value) const
	Test whether given value is present. More...

int	getIndex (const T &value) const
	Get index of given value. More...

const mapped_type &	operator[] (typename JClass< key_type >::argument_type key) const
	Get mapped value. More...

mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value. More...

void	put (typename JClass< key_type > ::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection. More...

Public Attributes
JHashMapEvaluator< JHashEvaluator >	getValue
	Function object for evaluation of element. More...

Protected Attributes
JTOOLS::JHashCollection::router_type	router

Private Member Functions
void	operator[] (int)

void	assign ()

void	resize ()

void	push_back ()

void	pop_back ()

Friends
std::ostream &	operator<< (std::ostream &out, const JDetector &detector)
	Write detector parameters to output stream. More...

Detailed Description

Detector geometry.

Definition at line 499 of file JGeometry.hh.

Member Typedef Documentation

◆ key_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef JKey_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::key_type

inherited

Definition at line 78 of file JHashMap.hh.

◆ mapped_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef JValue_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::mapped_type

inherited

Definition at line 79 of file JHashMap.hh.

◆ value_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef std::pair<JKey_t, JValue_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::value_type

inherited

Definition at line 80 of file JHashMap.hh.

◆ evaluator_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef JHashMapEvaluator<JEvaluator_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::evaluator_type

inherited

Definition at line 81 of file JHashMap.hh.

◆ collection_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef JHashCollection<value_type, evaluator_type> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::collection_type

inherited

Definition at line 83 of file JHashMap.hh.

◆ container_type

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef collection_type::container_type JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::container_type

inherited

Definition at line 84 of file JHashMap.hh.

◆ const_iterator

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef container_type::const_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_iterator

inherited

Definition at line 86 of file JHashMap.hh.

◆ const_reverse_iterator

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef container_type::const_reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_reverse_iterator

inherited

Definition at line 87 of file JHashMap.hh.

◆ iterator

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef container_type::iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::iterator

inherited

Definition at line 88 of file JHashMap.hh.

◆ reverse_iterator

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

typedef container_type::reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reverse_iterator

inherited

Definition at line 89 of file JHashMap.hh.

Constructor & Destructor Documentation

◆ JDetector() [1/2]

JACOUSTICS::JGEOMETRY::JDetector::JDetector ( )

inline

Default constructor.

Definition at line 505 of file JGeometry.hh.

506 {}

◆ JDetector() [2/2]

JACOUSTICS::JGEOMETRY::JDetector::JDetector	(	const JDETECTOR::JDetector &	detector,
		const std::vector< JHydrophone > &	hydrophones = `std::vector<JHydrophone>()`
	)

inline

Constructor.

Note that the positions of the base modules correspond to the reference position of the string.
As a consequence, a base module (i.e. floor = 0) is required for each string.
Missing base modules should therefore be added beforehand (e.g. using application JDetectorDB.cc).

Note that if the position of a hydrophone is not available, it is assumed that there is no hydrophone on that string.
If the position of the hydrophone is manually set, the corresponding parameter JString::has_hydrophone should be set to true.

Parameters

detector	detector
hydrophones	container with data of hydrophones

Definition at line 524 of file JGeometry.hh.

       {
         using namespace std;
         using namespace JPP;
  
         map<int, vector<module_type> > buffer;                            // string -> modules
  
         for (JDETECTOR::JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {
           buffer[module->getString()].push_back(module_type(module->getLocation(), module->getPosition()));
         }
  
         for (map<int, vector<module_type> >::iterator i = buffer.begin(); i != buffer.end(); ++i) {
  
           sort(i->second.begin(), i->second.end(), make_comparator(&module_type::getFloor));
  
           if (i->second[0].getFloor() == 0) {
  
             JString& string = (*this)[i->first];
  
             vector<module_type>::iterator p = i->second.begin();
  
             ++p;
  
             string = JGEOMETRY::JString(i->second[0].getPosition(), getMechanics(i->first), p, i->second.end());
  
             try {
  
               string.hydrophone     = getPosition(hydrophones.begin(),
                                                   hydrophones.end(),
                                                   make_predicate(&JHydrophone::getString, i->first));
  
               string.has_hydrophone = true;
             }
             catch(const exception&) {
               string.has_hydrophone = false;
             }
  
           } else {
  
             THROW(JNoValue, "No floor 0 in string " << i->first << "; use e.g. JDetectorDB -W.");
           }
         }
       }

Member Function Documentation

◆ hasString()

bool JACOUSTICS::JGEOMETRY::JDetector::hasString ( int string ) const

inline

Check if this detector has given string.

Parameters

string string

Returns: true if string present; else false

Definition at line 576 of file JGeometry.hh.

       {
         return this->has(string);
       }

◆ hasLocation()

bool JACOUSTICS::JGEOMETRY::JDetector::hasLocation ( const JLocation & location ) const

inline

Check if this detector has given location.

Parameters

location location

Returns: true if location present; else false

Definition at line 588 of file JGeometry.hh.

       {
         return this->hasString(location.getString()) && (*this)[location.getString()].hasFloor(location.getFloor());
       }

◆ clear()

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

virtual void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::clear ( )

inlineoverridevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 107 of file JHashMap.hh.

     {
       collection_type::clear();
     }

◆ reset()

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reset ( )

inlineinherited

Reset values.

Definition at line 116 of file JHashMap.hh.

     {
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->second = mapped_type();
       }
     }

◆ set()

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::set	(	const JHashMap< JKey_t, JValue_t, JEvaluator_t > &	source,
		const mapped_type &	value
	)

inlineinherited

Set values corresponding to keys in given source.

Parameters

source	source
value	value

Definition at line 130 of file JHashMap.hh.

     {
       this->clear();
  
       for (const_iterator i = source.begin(); i != source.end(); ++i) {
         (*this)[i->first] = value;
       }
     }

◆ get() [1/4]

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

virtual mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key )

inlineoverridevirtualinherited

Get mapped value.

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 146 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
       
       if (!this->router.has(ival)) {
         collection_type::insert(value_type(key, mapped_type()));
       }
  
       return container_type::operator[](this->router.get(ival)).second;
     }

◆ get() [2/4]

template<class JKey_t , class JValue_t , class JEvaluator_t = JHashEvaluator>

virtual const mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key ) const

inlineoverridevirtualinherited

Get mapped value.

This method will throw an exception if given key is not present following the prerequisite of constness.

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 166 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
  
       if (this->router.has(ival))
         return container_type::operator[](this->router.get(ival)).second;
       else
         THROW(JIndexOutOfRange, "JHashMap::get(): invalid key " << STREAM("?") << key);
     }

◆ get() [3/4]

value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::get ( const T & value )

inlineinherited

Get element with given value.

This method will throw an exception if given value is not present following the prerequisite of constness.

Parameters

value value

Returns: element

Definition at line 176 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
  
       if (!router.has(ival)) {
         this->insert(value);
       }
  
       return container_type::operator[](router.get(ival)).second;
     }

◆ get() [4/4]

const value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::get ( const T & value ) const

inlineinherited

Get element with given value.

This method will throw an exception if given value is not present following the prerequisite of constness.

Parameters

value value

Returns: element

Definition at line 197 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
  
       if (router.has(ival)) {
         return container_type::operator[](router.get(ival)).second;
       }
  
       THROW(JIndexOutOfRange, "JHashCollection::get(): invalid value.");
     }

◆ swap()

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::swap ( JHashCollection< std::pair< JKey_t, JValue_t >, JHashMapEvaluator< JHashEvaluator > > & collection )

inlineinherited

Swap hash collection.

Parameters

collection hash collection

Definition at line 123 of file JHashCollection.hh.

     {
       router.swap(collection.router);
  
       container_type::swap(collection);
     }

◆ find() [1/2]

const_iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::find ( const T & value ) const

inlineinherited

Find element with given value.

Parameters

value value

Returns: position of element with given value or end()

Definition at line 138 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
  
       if (router.has(ival))
         return this->begin() + router.get(ival);
       else
         return this->end();
     }

◆ find() [2/2]

iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::find ( const T & value )

inlineinherited

Find element with given value.

Parameters

value value

Returns: position of element with given value or end()

Definition at line 156 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
  
       if (router.has(ival))
         return this->begin() + router.get(ival);
       else
         return this->end();
     }

◆ insert() [1/2]

virtual bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::insert ( const value_type & element )

inlinevirtualinherited

Insert element.

Parameters

element element

Returns: true if inserted; else false

Definition at line 215 of file JHashCollection.hh.

     {
       const int ival = this->getValue(element);
  
       if (!router.has(ival)) {
         
         container_type::push_back(element);
  
         router.put(ival, this->size() - 1);
  
         return true;
       }
  
       return false;
     }

◆ insert() [2/2]

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::insert	(	T	__begin,
		T	__end
	)

inlineinherited

Insert values.

Parameters

__begin	begin of values
__end	end of values

Definition at line 239 of file JHashCollection.hh.

     {
       for (T i = __begin; i != __end; ++i) {
         insert(*i);
       }
     }

◆ erase() [1/3]

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::erase ( iterator pos )

inlineinherited

Erase element at given position.

Parameters

pos	valid position

Definition at line 252 of file JHashCollection.hh.

     {
       router.put(this->getValue(*pos), router.getDefaultAddress());
  
       for (iterator i = container_type::erase(pos); i != this->end(); ++i) {
         router.put(this->getValue(*i), distance(this->begin(), i));
       }
     }

◆ erase() [2/3]

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::erase	(	iterator	__begin,
		iterator	__end
	)

inlineinherited

Erase elements in given range.

Parameters

__begin	begin position (included)
__end	end position (excluded)

Definition at line 268 of file JHashCollection.hh.

     {
       for (iterator i = __begin; i != __end; ++i) {
         router.put(this->getValue(*i), router.getDefaultAddress());
       }
  
       for (iterator i = container_type::erase(__begin, __end); i != this->end(); ++i) {
         router.put(this->getValue(*i), distance(this->begin(), i));
       }
     }

◆ erase() [3/3]

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::erase ( const T & value )

inlineinherited

Erase element with given value.

Parameters

value value

Returns: true if element has been erased; else false

Definition at line 287 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
  
       if (router.has(ival)) {
  
         this->erase(this->begin() + router.get(ival)); 
  
         return true;
       }
  
       return false;
     }

◆ has()

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::has ( const T & value ) const

inlineinherited

Test whether given value is present.

Parameters

value value

Returns: true if present; else false

Definition at line 309 of file JHashCollection.hh.

     {
       return router.has(this->getValue(value));
     }

◆ getIndex()

int JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::getIndex ( const T & value ) const

inlineinherited

Get index of given value.

Parameters

value value

Returns: indecx

Definition at line 322 of file JHashCollection.hh.

     {
       return router.get(this->getValue(value));
     }

◆ operator[]() [1/3]

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::operator[] ( int )

privateinherited

◆ operator[]() [2/3]

template<class JKey_t , class JValue_t >

const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key ) const

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 73 of file JMappableCollection.hh.

     {
       return get(key);
     }

◆ operator[]() [3/3]

template<class JKey_t , class JValue_t >

mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key )

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 85 of file JMappableCollection.hh.

     {
       return get(key);
     }

◆ assign()

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::assign ( )

privateinherited

◆ resize()

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::resize ( )

privateinherited

◆ push_back()

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::push_back ( )

privateinherited

◆ pop_back()

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::pop_back ( )

privateinherited

◆ put()

template<class JKey_t , class JValue_t >

void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put	(	typename JClass< key_type > ::argument_type	key,
		typename JClass< mapped_type >::argument_type	value
	)

inlineinherited

Put pair-wise element (key,value) into collection.

Parameters

key	key
value	value

Definition at line 97 of file JMappableCollection.hh.

     {
       get(key) = value;
     }

Friends And Related Function Documentation

◆ operator<<

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

friend

Write detector parameters to output stream.

Parameters

out	output stream
detector	detector

Returns: output stream

Definition at line 601 of file JGeometry.hh.

       {
         using namespace std;
  
         for (JDetector::const_iterator i = detector.begin(); i != detector.end(); ++i) {
           out << setw(4) << i->first << endl << i->second;
         }
  
         return out;
       }

Member Data Documentation

◆ getValue

JHashMapEvaluator< JHashEvaluator > JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::getValue

inherited

Function object for evaluation of element.

Definition at line 331 of file JHashCollection.hh.

◆ router

JTOOLS::JHashCollection::router_type JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JHashEvaluator > >::router

protectedinherited

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

JGeometry.hh

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ key_type

◆ mapped_type

◆ value_type

◆ evaluator_type

◆ collection_type

◆ container_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JDetector() [1/2]

◆ JDetector() [2/2]

Member Function Documentation

◆ hasString()

◆ hasLocation()

◆ clear()

◆ reset()

◆ set()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ swap()

◆ find() [1/2]

◆ find() [2/2]

◆ insert() [1/2]

◆ insert() [2/2]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ has()

◆ getIndex()

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

◆ assign()

◆ resize()

◆ push_back()

◆ pop_back()

◆ put()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ getValue

◆ router