org.lsst.ccs.subsystem.focalplane.ui.fpmap

Class Template

java.lang.Object

org.lsst.ccs.subsystem.focalplane.ui.fpmap.Template

All Implemented Interfaces:

Serializable, Comparable<Template>

public class Template
extends Object
implements Serializable, Comparable<Template>

A template that defines a class of data channels - one channel per FocalPlaneMap cell.

Author:

onoprien

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	code
Segment	segment

Constructor Summary

Constructors

Constructor and Description
Template(String code, Segment segment)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Template other)
boolean	equals(Object obj)
String	getAgent()
int	hashCode()
String	toString() Produces a String representation of this template.
static Template	valueOf(org.lsst.ccs.gconsole.agent.AgentChannel channel) Constructs a template corresponding to the specified channel.
static Template	valueOf(String string) Constructs a template corresponding to the specified String representation.

Methods inherited from class java.lang.Object

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

Field Detail

code

public final String code

segment

public final Segment segment

Constructor Detail

Template

public Template(String code,
                Segment segment)

Method Detail

getAgent

public String getAgent()

valueOf

public static Template valueOf(org.lsst.ccs.gconsole.agent.AgentChannel channel)

Constructs a template corresponding to the specified channel.

Parameters:

channel - Data channel.

Returns:

Template, or null if the channel does not have metadata for placement on the FocalPlaneMap.

valueOf

public static Template valueOf(String string)

Constructs a template corresponding to the specified String representation.

Parameters:

string - String representation created by toString() method.

Returns:

Template.

Throws:

IllegalArgumentException - if the specified String cannot be converted to a template.

toString

public String toString()

Produces a String representation of this template. The string is human-readable, and can be converted back to a Template by calling valueOf(String string) method.

Overrides:

toString in class Object

Returns:

String representation of this template.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Template other)

Specified by:

compareTo in interface Comparable<Template>