org.lcsim.detector.identifier

Class IdentifierField

java.lang.Object

org.lcsim.detector.identifier.IdentifierField

All Implemented Interfaces:

IIdentifierField

public class IdentifierField
extends Object
implements IIdentifierField

Implementation of IIdentifierField.

Version:

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

Author:

Jeremy McCormick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentifierField.ValueOutOfRangeException

Field Summary

Fields

Modifier and Type	Field and Description
private int	intMask
private boolean	isSigned
private String	label
private long	longMask
private static int	MAX_BITS
private static int	MAX_OFFSET
private int	maxValue
private static int	MIN_BITS
private static int	MIN_OFFSET
private int	minValue
private int	numberOfBits
private int	offset

Constructor Summary

Constructors

Constructor and Description
IdentifierField(String label, int numberOfBits, int offset, boolean isSigned)

Method Summary

Methods

Modifier and Type	Method and Description
int	getIntegerMask() Get mask on as int value.
String	getLabel() Get the string label associated with this field.
long	getLongMask() Get mask on as long value.
int	getMaxValue() Get the maximum inclusive value that can be stored in this field.
int	getMinValue() Get the minimum inclusive value that can be stored in this field.
int	getNumberOfBits() Get the number of bits in this field.
int	getOffset() Get offset, or starting position, of this field.
boolean	isSigned() True if field is capable of holding signed values.
boolean	isValidValue(int value) True if value is within valid range of field values; false if not.
IIdentifier	pack(int value) Pack a single value of this field into a IIdentifier.
void	pack(int value, IIdentifier id) Pack a single value this field into an existing IIdentifier, preserving the other field values that may be present.
String	toString()
int	unpack(IIdentifier compact) Unpack and return the value of this field from a 64-bit IIdentifier.
int	unpack(long value) Unpack and return the value of this field from a raw long.

Methods inherited from class java.lang.Object

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

Field Detail

label

private String label

numberOfBits

private int numberOfBits

offset

private int offset

isSigned

private boolean isSigned

maxValue

private int maxValue

minValue

private int minValue

longMask

private long longMask

intMask

private int intMask

MAX_OFFSET

private static final int MAX_OFFSET

See Also:

Constant Field Values

MIN_OFFSET

private static final int MIN_OFFSET

See Also:

Constant Field Values

MAX_BITS

private static final int MAX_BITS

See Also:

Constant Field Values

MIN_BITS

private static final int MIN_BITS

See Also:

Constant Field Values

Constructor Detail

IdentifierField

public IdentifierField(String label,
               int numberOfBits,
               int offset,
               boolean isSigned)

Method Detail

getLabel

public String getLabel()

Description copied from interface: IIdentifierField

Get the string label associated with this field.

Specified by:

getLabel in interface IIdentifierField

Returns:

The label.

getNumberOfBits

public int getNumberOfBits()

Description copied from interface: IIdentifierField

Get the number of bits in this field.

Specified by:

getNumberOfBits in interface IIdentifierField

Returns:

The number of bits in this field.

getOffset

public int getOffset()

Description copied from interface: IIdentifierField

Get offset, or starting position, of this field.

Specified by:

getOffset in interface IIdentifierField

Returns:

The offset of the field.

isSigned

public boolean isSigned()

Description copied from interface: IIdentifierField

True if field is capable of holding signed values.

Specified by:

isSigned in interface IIdentifierField

Returns:

True if field is signed.

toString

public String toString()

Overrides:

toString in class Object

unpack

public int unpack(long value)

Description copied from interface: IIdentifierField

Unpack and return the value of this field from a raw long.

Specified by:

unpack in interface IIdentifierField

Returns:

Field's int value.

unpack

public int unpack(IIdentifier compact)

Description copied from interface: IIdentifierField

Unpack and return the value of this field from a 64-bit IIdentifier.

Specified by:

unpack in interface IIdentifierField

Returns:

Field's int value.

pack

public IIdentifier pack(int value)

Description copied from interface: IIdentifierField

Pack a single value of this field into a IIdentifier.

Specified by:

pack in interface IIdentifierField

Parameters:

value - A value to pack into this field.

Returns:

An identifier with the packed value.

pack

public void pack(int value,
        IIdentifier id)

Description copied from interface: IIdentifierField

Pack a single value this field into an existing IIdentifier, preserving the other field values that may be present.

Specified by:

pack in interface IIdentifierField

Parameters:

value - The field value.

id - An Identifier.

getMaxValue

public int getMaxValue()

Description copied from interface: IIdentifierField

Get the maximum inclusive value that can be stored in this field.

Specified by:

getMaxValue in interface IIdentifierField

Returns:

The maximum field value.

getMinValue

public int getMinValue()

Description copied from interface: IIdentifierField

Get the minimum inclusive value that can be stored in this field.

Specified by:

getMinValue in interface IIdentifierField

Returns:

The minimum field value.

getIntegerMask

public int getIntegerMask()

Description copied from interface: IIdentifierField

Get mask on as int value.

Specified by:

getIntegerMask in interface IIdentifierField

Returns:

The on mask on an int.

getLongMask

public long getLongMask()

Description copied from interface: IIdentifierField

Get mask on as long value.

Specified by:

getLongMask in interface IIdentifierField

Returns:

The on mask as a long.

isValidValue

public boolean isValidValue(int value)

Description copied from interface: IIdentifierField

True if value is within valid range of field values; false if not.

Specified by:

isValidValue in interface IIdentifierField

Returns:

True if value is valid; false if not.