JDATABASE::JLocation_t Struct Reference

Auxiliary data structure for location of product in detector. More...

#include <JLocation_t.hh>

Inheritance diagram for JDATABASE::JLocation_t:

Public Member Functions
	JLocation_t ()
	Default constructor. More...
	JLocation_t (const int string, const int floor, const int position)
	Constructor. More...
bool	is_valid () const
	Check validity of location. More...
bool	less (const JLocation_t &location) const
	Less-than method. More...

Public Attributes
int	string
	position in detector More...
int	floor
	position in string More...
int	position
	position in floor More...

Friends
std::ostream &	operator<< (std::ostream &out, const JLocation_t &object)
	Write location to output stream. More...

Detailed Description

Auxiliary data structure for location of product in detector.

Definition at line 24 of file JLocation_t.hh.

Constructor & Destructor Documentation

JDATABASE::JLocation_t::JLocation_t ( )

inline

Default constructor.

The default corresponds to an invalid location.

Definition at line 31 of file JLocation_t.hh.

                  :
      string  (-1),
      floor   (-1),
      position(-1)
    {}

JDATABASE::JLocation_t::JLocation_t ( const int  string, const int  floor, const int  position  )

inline

Constructor.

Parameters

string	string
floor	floor
position	position

Definition at line 45 of file JLocation_t.hh.

                                    :
      string  (string),
      floor   (floor),
      position(position)
    {}

Member Function Documentation

bool JDATABASE::JLocation_t::is_valid ( ) const

inline

Check validity of location.

Returns

true if valid; else false

Definition at line 59 of file JLocation_t.hh.

    {
      return *this != JLocation_t();
    }

bool JDATABASE::JLocation_t::less ( const JLocation_t &  location ) const

inline

Less-than method.

Parameters

location

location

Returns

true if this location less than given location; else false

Definition at line 71 of file JLocation_t.hh.

    {
      if (this->string == location.string) {

        if (this->floor == location.floor)
          return this->position < location.position;
        else
          return this->floor    < location.floor;

      } else {

        return this->string < location.string;
      }
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, const JLocation_t &  object  )

friend

Write location to output stream.

Parameters

out	output stream
object	location

Returns

output stream

Definition at line 94 of file JLocation_t.hh.

    {
      using namespace std;
      using namespace JPP;

      return out << FILL(4,'0') << object.string   << '.'
                 << FILL(2,'0') << object.floor    << '.'
                 << FILL(2,'0') << object.position << FILL();
    }

Member Data Documentation

int JDATABASE::JLocation_t::string

position in detector

Definition at line 105 of file JLocation_t.hh.

int JDATABASE::JLocation_t::floor

position in string

Definition at line 106 of file JLocation_t.hh.

int JDATABASE::JLocation_t::position

position in floor

Definition at line 107 of file JLocation_t.hh.

---

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

• JLocation_t.hh