org.lcsim.detector.identifier

Interface IIdentifier

All Superinterfaces:

Comparable

All Known Implementing Classes:

Identifier

public interface IIdentifier
extends Comparable

An interface defining comparable 64-bit identifiers using for uniquely defining components of the detector.

Version:

$Id: IIdentifier.java,v 1.5 2007/05/09 00:59:58 jeremy Exp $

Author:

Jeremy McCormick

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the state of this identifier, setting the value to 0.
void	fromHexString(String hexRep) Set the value from a raw hex string.
long	getValue() Get the value of this identifier as a long.
boolean	isValid() True if this ID has been set; False if it has not been set or was set and clear() was called.
void	setValue(long id) Set the value of this identifier from a long.
String	toHexString() Get a raw hex string representation.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getValue

long getValue()

Get the value of this identifier as a long.

Returns:

The long value.

setValue

void setValue(long id)

Set the value of this identifier from a long.

Parameters:

id - The long value.

toHexString

String toHexString()

Get a raw hex string representation.

Returns:

The raw hex string.

fromHexString

void fromHexString(String hexRep)

Set the value from a raw hex string.

Parameters:

hexRep - The hex representation.

clear

void clear()

Clear the state of this identifier, setting the value to 0.

isValid

boolean isValid()

True if this ID has been set; False if it has not been set or was set and clear() was called.

Returns:

True if this ID is valid.