JDETECTOR::JModuleAddress Class Reference

Address of module in detector data structure. More...

#include <JModuleAddress.hh>

Inheritance diagram for JDETECTOR::JModuleAddress:

Public Member Functions
	JModuleAddress ()
	Default constructor. More...
	JModuleAddress (const int index)
	Constructor. More...
bool	equals (const JModuleAddress &address) const
	Equal method. More...

Public Attributes
int	first
	index of module in detector data structure More...

Friends
std::istream &	operator>> (std::istream &in, JModuleAddress &object)
	Read module address from input. More...
std::ostream &	operator<< (std::ostream &out, const JModuleAddress &object)
	Write module address to output. More...

Detailed Description

Address of module in detector data structure.

The address of a module consists of a single integer value JModuleAddress::first which refers to the index of the module in the detector data structure.

This class implements the JLANG::JEquals interface.

Definition at line 30 of file JModuleAddress.hh.

Constructor & Destructor Documentation

JDETECTOR::JModuleAddress::JModuleAddress ( )

inline

Default constructor.

Definition at line 37 of file JModuleAddress.hh.

                     :
      first(-1)
    {}

JDETECTOR::JModuleAddress::JModuleAddress ( const int  index )

inlineexplicit

Constructor.

Parameters

index

index

Definition at line 47 of file JModuleAddress.hh.

                                             :
      first(index)
    {}

Member Function Documentation

bool JDETECTOR::JModuleAddress::equals ( const JModuleAddress &  address ) const

inline

Equal method.

Parameters

address

module address

Returns

true if this module address equal to given module address; else false

Definition at line 58 of file JModuleAddress.hh.

    {
      return this->first == address.first;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JModuleAddress &  object  )

friend

Read module address from input.

Parameters

in	input stream
object	module address

Returns

input stream

Definition at line 71 of file JModuleAddress.hh.

    {
      return in >> object.first;
    }

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

friend

Write module address to output.

Parameters

out	output stream
object	module address

Returns

output stream

Definition at line 84 of file JModuleAddress.hh.

    {
      return out << object.first;
    }

Member Data Documentation

int JDETECTOR::JModuleAddress::first

index of module in detector data structure

Definition at line 90 of file JModuleAddress.hh.

---

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

• JModuleAddress.hh