JDETECTOR::JModuleLocation Class Reference

Logical location of module. More...

#include <JModuleLocation.hh>

Inheritance diagram for JDETECTOR::JModuleLocation:

Public Member Functions
	JModuleLocation ()
	Default constructor. More...
	JModuleLocation (const int string, const int floor)
	Constructor. More...
const JModuleLocation &	getLocation () const
	Get location. More...
JModuleLocation &	getLocation ()
	Get location. More...
void	setLocation (const JModuleLocation &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 JModuleLocation &location) const
	Less than method. More...

Protected Attributes
int	string
int	floor

Friends
std::istream &	operator>> (std::istream &in, JModuleLocation &location)
	Read module location from input. More...
std::ostream &	operator<< (std::ostream &out, const JModuleLocation &location)
	Write module location to output. More...
JReader &	operator>> (JReader &in, JModuleLocation &location)
	Read module location from input. More...
JWriter &	operator<< (JWriter &out, const JModuleLocation &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 36 of file JModuleLocation.hh.

Constructor & Destructor Documentation

JDETECTOR::JModuleLocation::JModuleLocation ( )

inline

Default constructor.

Definition at line 43 of file JModuleLocation.hh.

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

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

inline

Constructor.

Parameters

string	string
floor	floor

Definition at line 55 of file JModuleLocation.hh.

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

Member Function Documentation

const JModuleLocation& JDETECTOR::JModuleLocation::getLocation ( ) const

inline

Get location.

Returns

location

Definition at line 68 of file JModuleLocation.hh.

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

JModuleLocation& JDETECTOR::JModuleLocation::getLocation ( )

inline

Get location.

Returns

location

Definition at line 79 of file JModuleLocation.hh.

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

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

inline

Set location.

Parameters

location

location

Definition at line 90 of file JModuleLocation.hh.

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

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

inline

Convert module location to string.

Returns

string

Definition at line 101 of file JModuleLocation.hh.

    {
      return toString("% %");
    }

std::string JDETECTOR::JModuleLocation::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 117 of file JModuleLocation.hh.

    {
      JLANG::JString buffer(fmt);

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

      return buffer;
    }

int JDETECTOR::JModuleLocation::getString ( ) const

inline

Get string number.

Returns

string number

Definition at line 133 of file JModuleLocation.hh.

    {
      return string;
    }

int JDETECTOR::JModuleLocation::getFloor ( ) const

inline

Get floor number.

Returns

floor number

Definition at line 144 of file JModuleLocation.hh.

    {
      return floor;
    }

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

inline

Less than method.

Parameters

location

module location

Returns

true if first location before second location; else false

Definition at line 156 of file JModuleLocation.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, JModuleLocation &  location  )

friend

Read module location from input.

Parameters

in	input stream
location	module location

Returns

input stream

Definition at line 172 of file JModuleLocation.hh.

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

      return in;
    }

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

friend

Write module location to output.

Parameters

out	output stream
location	module location

Returns

output stream

Definition at line 188 of file JModuleLocation.hh.

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

      return out;
    }

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

friend

Read module location from input.

Parameters

in	reader
location	module location

Returns

reader

Definition at line 207 of file JModuleLocation.hh.

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

      return in;
    }

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

friend

Write module location to output.

Parameters

out	writer
location	module location

Returns

writer

Definition at line 223 of file JModuleLocation.hh.

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

      return out;
    }

Member Data Documentation

int JDETECTOR::JModuleLocation::string

protected

Definition at line 233 of file JModuleLocation.hh.

int JDETECTOR::JModuleLocation::floor

protected

Definition at line 234 of file JModuleLocation.hh.

---

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

• JModuleLocation.hh