org.lcsim.detector.identifier

Interface IIdentifierHelper

All Known Implementing Classes:

DetectorIdentifierHelper, IdentifierHelper, SiTrackerIdentifierHelper

public interface IIdentifierHelper

This class has a reference to a single IIdentifierDictionary that specifies the fields for a 64-bit IIdentifier. The {pack(IExpandedIdentifier) method is used to turn an IExpandedIdentifier of field values into a compact, or packed, identifier. The unpack(IIdentifier) method does the reverse, taking a packed IIdentifier and turning into a list of field values. The #getValue(IIdentifier compact, IIdentifierField desc ) method is used to unpack a single field value. There are similar, overloaded methods for using an index in the dictionary or a field label to retrieve a single field value.

Version:

$Id: IIdentifierHelper.java,v 1.11 2011/02/25 03:09:38 jeremy Exp $

Author:

Jeremy McCormick

See Also:

org.lcsim.detector.identifier, IIdentifier, IExpandedIdentifier, IIdentifierDictionary

Method Summary

Methods

Modifier and Type	Method and Description
IExpandedIdentifier	createExpandedIdentifier()
int	getFieldIndex(String fieldName) Wraps IIdentifierDictionary.getFieldIndex(String).
IIdentifierDictionary	getIdentifierDictionary() Get the IIdentifierDictionary associated with this helper.
int	getValue(IIdentifier compact, int field) Get a single field value by index.
int	getValue(IIdentifier compact, String field) Get a single field value by name.
boolean	hasField(String fieldName) Pushed up from IIdentifierDictionary.hasField(String).
IIdentifier	pack(IExpandedIdentifier id) Pack an IExpandedIdentifier into a compact IIdentifier.
IExpandedIdentifier	unpack(IIdentifier id) Upack the IIdentifier into an IExpandedIdentifier containing the field values in a list.

Method Detail

getIdentifierDictionary

IIdentifierDictionary getIdentifierDictionary()

Get the IIdentifierDictionary associated with this helper.

Returns:

The IdentifierDictionary.

pack

IIdentifier pack(IExpandedIdentifier id)

Pack an IExpandedIdentifier into a compact IIdentifier.

Parameters:

id - The ExpandedIdentifier to be packed.

Returns:

The compact identfier.

unpack

IExpandedIdentifier unpack(IIdentifier id)

Upack the IIdentifier into an IExpandedIdentifier containing the field values in a list.

Parameters:

id - The Identifier.

Returns:

An ExpandedIdentifier.

getValue

int getValue(IIdentifier compact,
           int field)

Get a single field value by index.

Parameters:

compact - The compact Identifier.

field - The field index in the dictionary.

Returns:

The field value.

getValue

int getValue(IIdentifier compact,
           String field)

Get a single field value by name.

Parameters:

compact - The compact Identifier.

field - The field index in the dictionary.

Returns:

The field value.

hasField

boolean hasField(String fieldName)

Pushed up from IIdentifierDictionary.hasField(String).

Parameters:

fieldName - The field name.

Returns:

True if this helper's dictionary has a field called fieldName; False if not.

getFieldIndex

int getFieldIndex(String fieldName)

Wraps IIdentifierDictionary.getFieldIndex(String).

Parameters:

fieldName -

Returns:

Throws:

FieldNotFoundException

createExpandedIdentifier

IExpandedIdentifier createExpandedIdentifier()