org.lsst.ccs.utilities.location

Class LocationSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Location>

org.lsst.ccs.utilities.location.LocationSet

All Implemented Interfaces:

Serializable, Iterable<Location>, Collection<Location>, Set<Location>

public class LocationSet
extends AbstractSet<Location>
implements Serializable

Default implementation of Set<Location>. This implementation uses a bitmap to represent the selected locations.

Author:

tonyj

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocationSet() Creates an empty location set
LocationSet(BitSet bitset) Create a location set based on DAQ location index based BitSet.
LocationSet(Set<Location> input) Creates a location set which is a copy of the provided set
LocationSet(String locations) Creates a LocationSet from a comma delimited String.

Method Summary

Modifier and Type	Method and Description
boolean	add(Location location)
static LocationSet	all() LocationSet for all locations.
int[]	asIntArray() Returns location set as list of integers using Owen's numbering scheme.
void	clear()
BitSet	getBitSet() Return the DAQ location index based BitSet
Iterator<Location>	iterator()
static LocationSet	of(String... location) Creates a LocationSet from a list of strings.
boolean	remove(Object location)
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, contains, containsAll, isEmpty, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

LocationSet

public LocationSet()

Creates an empty location set

LocationSet

public LocationSet(String locations)

Creates a LocationSet from a comma delimited String.

Parameters:

locations - The locations

See Also:

Location.of(java.lang.String)

LocationSet

public LocationSet(Set<Location> input)

Creates a location set which is a copy of the provided set

Parameters:

input - The location set to copy

LocationSet

public LocationSet(BitSet bitset)

Create a location set based on DAQ location index based BitSet.

Parameters:

bitset -

Method Detail

all

public static LocationSet all()

LocationSet for all locations.

Returns:

A LocationSet containing all valid locations

of

public static LocationSet of(String... location)

Creates a LocationSet from a list of strings. Also works for a single comma delimited String.

Parameters:

location - The location(s)

Returns:

The LocationSet

See Also:

Location.of(java.lang.String)

getBitSet

public BitSet getBitSet()

Return the DAQ location index based BitSet

Returns:

add

public boolean add(Location location)

Specified by:

add in interface Collection<Location>

Specified by:

add in interface Set<Location>

Overrides:

add in class AbstractCollection<Location>

clear

public void clear()

Specified by:

clear in interface Collection<Location>

Specified by:

clear in interface Set<Location>

Overrides:

clear in class AbstractCollection<Location>

remove

public boolean remove(Object location)

Specified by:

remove in interface Collection<Location>

Specified by:

remove in interface Set<Location>

Overrides:

remove in class AbstractCollection<Location>

iterator

public Iterator<Location> iterator()

Specified by:

iterator in interface Iterable<Location>

Specified by:

iterator in interface Collection<Location>

Specified by:

iterator in interface Set<Location>

Specified by:

iterator in class AbstractCollection<Location>

size

public int size()

Specified by:

size in interface Collection<Location>

Specified by:

size in interface Set<Location>

Specified by:

size in class AbstractCollection<Location>

asIntArray

public int[] asIntArray()

Returns location set as list of integers using Owen's numbering scheme.

Returns:

An int array