org.lsst.ccs.subsystem.common.ui.focalplane

Enum Segment

java.lang.Object

java.lang.Enum<Segment>

org.lsst.ccs.subsystem.common.ui.focalplane.Segment

All Implemented Interfaces:

Serializable, Comparable<Segment>

public enum Segment
extends Enum<Segment>

Enumeration of the Focal Plane standard hardware segments.

Author:

onoprien

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMP
CCD
RAFT
REB

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_GROUP
static Pattern	FP_PATH_PATTERN
static String	GROUP_GROUP
static int[]	N

Method Summary

Modifier and Type	Method and Description
static int[]	getIndices(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Computes focal plane segment indices for the given channel, based on attributes.
static int[]	getIndices(String path) Computes focal plane segment indices for the given path.
String	getKey() Returns the attribute key that can be used to retrieve the corresponding segment index value from DataProviderInfo.
int	getNX()
int	getNY()
static String	getPathPrefix(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel) Returns standardized path prefix for the specified channel.
static String	getPathPrefix(int[] indices) Returns standardized path prefix for a channel with given segment indices.
static String	getPathPrefix(String path) Returns standardized path prefix for the specified channel.
static String	stripPathPrefix(String path) Strips path prefix indicating the segment location on the focal plane from the given path.
String	toString() Returns string representation of this segment type.
static Segment	valueOf(String name) Returns the enum constant of this type with the specified name.
static Segment[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RAFT

public static final Segment RAFT

REB

public static final Segment REB

CCD

public static final Segment CCD

AMP

public static final Segment AMP

Field Detail

AGENT_GROUP

public static final String AGENT_GROUP

See Also:

Constant Field Values

GROUP_GROUP

public static final String GROUP_GROUP

See Also:

Constant Field Values

FP_PATH_PATTERN

public static final Pattern FP_PATH_PATTERN

N

public static final int[] N

Method Detail

values

public static Segment[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Segment c : Segment.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Segment valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNX

public int getNX()

getNY

public int getNY()

getKey

public String getKey()

Returns the attribute key that can be used to retrieve the corresponding segment index value from DataProviderInfo.

Returns:

Attribute key.

toString

public String toString()

Returns string representation of this segment type. This representation should be used for constructing or parsing channel paths, and anywhere human-readable text needs to be produced.

Overrides:

toString in class Enum<Segment>

Returns:

String representation of this segment type.

getIndices

public static int[] getIndices(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel)

Computes focal plane segment indices for the given channel, based on attributes.

Parameters:

channel - Data channel.

Returns:

Array of length 6: [raftX, raftY, reb = ccdX, ccdY, ampX, ampY], or null if the channel does not belong to a valid segment. Trailing indices will be -1 if there is no corresponding segment at this level, but at least raft indices will have valid non-negative values.

getIndices

public static int[] getIndices(String path)

Computes focal plane segment indices for the given path.

Parameters:

path - Original or display path in [subsystem/]RXX[/RebX][/SXX[/SegmentXX]]/group format.

Returns:

Array of length 6: [raftX, raftY, reb = ccdX, ccdY, ampX, ampY], or null if the channel does not belong to a valid segment. Trailing indices will be -1 if there is no corresponding segment at this level, but at least raft indices will have valid non-negative values.

getPathPrefix

public static String getPathPrefix(int[] indices)

Returns standardized path prefix for a channel with given segment indices. The prefix format is [RXX/[RebX/[SXX/[SegmentXX/]]]] (the REB segment is always present if the CCD segment is) The returned prefix is empty if raft indices are "-1" or the argument is null.

Parameters:

indices - Array of length 6: [raftX, raftY, reb = ccdX, ccdY, ampX, ampY].

Returns:

Path prefix.

getPathPrefix

public static String getPathPrefix(org.lsst.ccs.gconsole.services.aggregator.AgentChannel channel)

Returns standardized path prefix for the specified channel. The prefix format is [RXX/[RebX/[SXX/[SegmentXX/]]]] (the REB segment is always present if the CCD segment is) This method constructs the prefix based on channel attributes, not on channel path. The returned prefix is empty if the channel does not belong to a valid segment; otherwise, the prefix ends with "/";

Parameters:

channel - Data channel.

Returns:

Path prefix.

getPathPrefix

public static String getPathPrefix(String path)

Returns standardized path prefix for the specified channel. The returned prefix is empty if the provided path does not allow determination of the focal plane segment is belongs to.

Parameters:

path - Data channel path.

Returns:

Path prefix.

stripPathPrefix

public static String stripPathPrefix(String path)

Strips path prefix indicating the segment location on the focal plane from the given path. The path should be in [subsystem/]RXX[/RebX][/SXX[/SegmentXX]]/group format. The returned string is [subsystem/]group. If the path does not contain a prefix in the expected format, the entire path is returned.

Parameters:

path - Original or display path

Returns:

Path with the prefix stripped.