JDETECTOR::JLocation Class Reference

Logical location of module. More...

#include <JLocation.hh>

Inheritance diagram for JDETECTOR::JLocation:

Public Member Functions
	JLocation ()
	Default constructor. More...
	JLocation (const int string, const int floor)
	Constructor. More...
const JLocation &	getLocation () const
	Get location. More...
JLocation &	getLocation ()
	Get location. More...
void	setLocation (const JLocation &location)
	Set location. More...
std::string	toString () const
	Convert module location to string. More...
std::string	toString (const std::string &fmt, const std::string target="%") const
	Convert module loation to string. More...
int	getString () const
	Get string number. More...
int	getFloor () const
	Get floor number. More...
bool	less (const JLocation &location) const
	Less than method. More...

Protected Attributes
int	string
int	floor

Friends
std::istream &	operator>> (std::istream &in, JLocation &location)
	Read module location from input. More...
std::ostream &	operator<< (std::ostream &out, const JLocation &location)
	Write module location to output. More...
JReader &	operator>> (JReader &in, JLocation &location)
	Read module location from input. More...
JWriter &	operator<< (JWriter &out, const JLocation &location)
	Write module location to output. More...

Detailed Description

Logical location of module.

The logical location of a module consists of a string and floor number.
This class implements the JLANG::JComparable interface.

Definition at line 37 of file JLocation.hh.

Constructor & Destructor Documentation

JDETECTOR::JLocation::JLocation ( )

inline

Default constructor.

Definition at line 44 of file JLocation.hh.

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

JDETECTOR::JLocation::JLocation ( const int  string, const int  floor  )

inline

Constructor.

Parameters

string	string
floor	floor

Definition at line 56 of file JLocation.hh.

    {
      this->string = string;
      this->floor  = floor;
    }

Member Function Documentation

const JLocation& JDETECTOR::JLocation::getLocation ( ) const

inline

Get location.

Returns

location

Definition at line 69 of file JLocation.hh.

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

JLocation& JDETECTOR::JLocation::getLocation ( )

inline

Get location.

Returns

location

Definition at line 80 of file JLocation.hh.

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

void JDETECTOR::JLocation::setLocation ( const JLocation &  location )

inline

Set location.

Parameters

location

location

Definition at line 91 of file JLocation.hh.

    {
      static_cast<JLocation&>(*this) = location;
    }

std::string JDETECTOR::JLocation::toString ( ) const

inline

Convert module location to string.

Returns

string

Definition at line 102 of file JLocation.hh.

    {
      return toString("% %");
    }

std::string JDETECTOR::JLocation::toString ( const std::string &  fmt, const std::string  target = "%"  ) const

inline

Convert module loation to string.

The targets target in the format string fmt are consecutively replaced by floor and string.

Parameters

fmt	format
target	target

Returns

string

Definition at line 118 of file JLocation.hh.

    {
      JLANG::JString buffer(fmt);

      buffer.replace(target, string, 1);
      buffer.replace(target, floor,  1);

      return buffer;
    }

int JDETECTOR::JLocation::getString ( ) const

inline

Get string number.

Returns

string number

Definition at line 134 of file JLocation.hh.

    {
      return string;
    }

int JDETECTOR::JLocation::getFloor ( ) const

inline

Get floor number.

Returns

floor number

Definition at line 145 of file JLocation.hh.

    {
      return floor;
    }

bool JDETECTOR::JLocation::less ( const JLocation &  location ) const

inline

Less than method.

Parameters

location

module location

Returns

true if first location before second location; else false

Definition at line 157 of file JLocation.hh.

    {
      if (this->getString() == location.getString())
        return this->getFloor()  < location.getFloor();
      else
        return this->getString() < location.getString();
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JLocation &  location  )

friend

Read module location from input.

Parameters

in	input stream
location	module location

Returns

input stream

Definition at line 173 of file JLocation.hh.

    {
      in >> location.string;
      in >> location.floor;

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JLocation &  location  )

friend

Write module location to output.

Parameters

out	output stream
location	module location

Returns

output stream

Definition at line 189 of file JLocation.hh.

    {
      using namespace std;
      
      out << setw(4) << location.string;
      out << ' ';
      out << setw(2) << location.floor;

      return out;
    }

JReader& operator>> ( JReader &  in, JLocation &  location  )

friend

Read module location from input.

Parameters

in	reader
location	module location

Returns

reader

Definition at line 208 of file JLocation.hh.

    {
      in >> location.string;
      in >> location.floor;

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JLocation &  location  )

friend

Write module location to output.

Parameters

out	writer
location	module location

Returns

writer

Definition at line 224 of file JLocation.hh.

    {
      out << location.string;
      out << location.floor;

      return out;
    }

Member Data Documentation

int JDETECTOR::JLocation::string

protected

Definition at line 234 of file JLocation.hh.

int JDETECTOR::JLocation::floor

protected

Definition at line 235 of file JLocation.hh.

---

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

• JLocation.hh