org.lcsim.detector

Class PhysicalVolumePath

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<IPhysicalVolume>

org.lcsim.detector.PhysicalVolumePath

All Implemented Interfaces:

Serializable, Cloneable, Iterable<IPhysicalVolume>, Collection<IPhysicalVolume>, List<IPhysicalVolume>, RandomAccess, IPhysicalVolumePath

public class PhysicalVolumePath
extends ArrayList<IPhysicalVolume>
implements IPhysicalVolumePath

An ordered list of PhysicalVolume objects corresponding to a unique path in a geometry of LogicalVolumes and PhysicalVolumes. The first volume should be the world volume.

Author:

Jeremy McCormick

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
PhysicalVolumePath()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(IPhysicalVolumePath path) Compare with another IPhysicalVolumePath.
boolean	equalsPrefix(IPhysicalVolumePath path) Compare the smallest prefix set of PhysicalVolumes together.
IPhysicalVolume	getLeafVolume() Get the bottom or last volume which is the leaf in this path.
IPhysicalVolume	getTopVolume() Get the top or first volume which is the world volume.
boolean	isEmpty() True if this IPhysicalVolumePath contains no PhysicalVolumes.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Constructor Detail

PhysicalVolumePath

public PhysicalVolumePath()

Method Detail

getTopVolume

public IPhysicalVolume getTopVolume()

Get the top or first volume which is the world volume.

Specified by:

getTopVolume in interface IPhysicalVolumePath

Returns:

The top volume.

getLeafVolume

public IPhysicalVolume getLeafVolume()

Get the bottom or last volume which is the leaf in this path.

Specified by:

getLeafVolume in interface IPhysicalVolumePath

Returns:

The leaf volume.

isEmpty

public boolean isEmpty()

True if this IPhysicalVolumePath contains no PhysicalVolumes.

Specified by:

isEmpty in interface Collection<IPhysicalVolume>

Specified by:

isEmpty in interface List<IPhysicalVolume>

Specified by:

isEmpty in interface IPhysicalVolumePath

Overrides:

isEmpty in class ArrayList<IPhysicalVolume>

Returns:

True if empty.

equals

public boolean equals(IPhysicalVolumePath path)

Compare with another IPhysicalVolumePath. False if path is null, if path is not the same size as this one, or if any of the PhysicalVolumes are different PhysicalVolume objects.

Specified by:

equals in interface IPhysicalVolumePath

Parameters:

path -

Returns:

True if the the paths are equal.

equalsPrefix

public boolean equalsPrefix(IPhysicalVolumePath path)

Compare the smallest prefix set of PhysicalVolumes together. For instance, these two IDs would return true. ExpandedIdentifier id1 = ExpandedIdentifier("/1/2/3"); ExpandedIdentifier id2 = ExpandedIdentifier("/1/2/");

Specified by:

equalsPrefix in interface IPhysicalVolumePath

Parameters:

path -

Returns:

True if the set of prefix fields is equal.

toString

public String toString()

Overrides:

toString in class AbstractCollection<IPhysicalVolume>