org.lcsim.recon.tracking.gtrbase

Class DetectorID

java.lang.Object

org.lcsim.recon.tracking.gtrbase.DetectorID

public class DetectorID
extends Object

This class defines methods that can construct a unique ID for any detector element. In order for two different subdetectors to have unique ids but allow each subdetector to implement its own numbering scheme , the ID ( 32 bits long integer ) reserves the last 8 bits. It uses them to identify each particular subdetector. The rest ( 24 bits ) are free for use by subdetectors. Each subdetector should implement its own numbering scheme . The ID is constructed using that subdetector ID . This way, the interperetation of subdetector ID is left to the discretion of each subdetector. It is in no way guaranteed that convention remains the same. The reserved 8 bits can be upper or lower or any other. It is required that subdetector ID should be no longer than 24 bits though. If subdetector follows that rule its subdetector id will be always packed and unpacked correctly.

Version:

1.0

Author:

Norman A. Graf

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_detid

Constructor Summary

Constructors

Constructor and Description
DetectorID() Construct a default instance.
DetectorID(DetectorID detid) Construct an instance replicating the DetectorID (copy constructor).
DetectorID(int detid) Construct an instance from a detector ID.
DetectorID(int dettyp, int subdetid) Construct an instance for detector type dettyp and subdetector id subdetid.

Method Summary

Methods

Modifier and Type	Method and Description
int	detectorId() Return the detector ID.
boolean	equals(DetectorID detid) Test equality.
boolean	lessThan(DetectorID detid) Test ordering.
boolean	notEquals(DetectorID detid) Test inequality.
int	subdetectorId() Return subdetector ID from detector id detid.
int	subdetectorType() Return the subdetector type.
String	toString() output stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_detid

protected int _detid

Constructor Detail

DetectorID

public DetectorID(int dettyp,
          int subdetid)

Construct an instance for detector type dettyp and subdetector id subdetid.

Parameters:

dettyp - The detector type.

subdetid - The subdetector type.

DetectorID

public DetectorID()

Construct a default instance.

DetectorID

public DetectorID(int detid)

Construct an instance from a detector ID.

Parameters:

detid - The detector ID.

DetectorID

public DetectorID(DetectorID detid)

Construct an instance replicating the DetectorID (copy constructor).

Parameters:

detid - The DetectorID to replicate.

Method Detail

subdetectorType

public int subdetectorType()

Return the subdetector type.

Returns:

The subdetector type.

subdetectorId

public int subdetectorId()

Return subdetector ID from detector id detid.

Returns:

The subdetector id.

detectorId

public int detectorId()

Return the detector ID.

Returns:

The detector ID.

toString

public String toString()

output stream

Overrides:

toString in class Object

Returns:

A String representation of this instance.

equals

public boolean equals(DetectorID detid)

Test equality.

Parameters:

detid - The DetectorID to test.

Returns:

true if the DetectorIDs are equal.

notEquals

public boolean notEquals(DetectorID detid)

Test inequality.

Parameters:

detid - The DetectorID to test.

Returns:

true if the DetectorIDs are not equal.

lessThan

public boolean lessThan(DetectorID detid)

Test ordering.

Parameters:

detid - The DetectorID to test.

Returns:

true if detid is larger.