org.lsst.ccs.drivers.rcm

Class ImageMetadata

java.lang.Object

org.lsst.ccs.drivers.rcm.ImageMetadata

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Image

public class ImageMetadata
extends Object
implements Serializable

Image metadata

Author:

Owen Saxton

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	address
protected int	cluster
protected int	element
protected int	format
protected int	length
protected int	schema
protected long	tag Private data.
protected int	version

Constructor Summary

Constructors

Constructor and Description
ImageMetadata() Constructors.
ImageMetadata(long tag, int length, int format, int schema, int version, int address, int cluster, int element)

Method Summary

Methods

Modifier and Type	Method and Description
int	getAddress() Gets the RCM address.
int	getCluster() Gets the CPU cluster number.
int	getElement() Gets the CPU element number.
int	getFormat() Gets the image format.
int	getLength() Gets the image length.
int	getSchema() Gets the firmware schema.
long	getTag() Gets the image tag.
int	getVersion() Gets the firmware version.
String	toString() Gets the string representation.

Methods inherited from class java.lang.Object

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

Field Detail

tag

protected long tag

Private data.

length

protected int length

format

protected int format

schema

protected int schema

version

protected int version

address

protected int address

cluster

protected int cluster

element

protected int element

Constructor Detail

ImageMetadata

public ImageMetadata()

Constructors.

ImageMetadata

public ImageMetadata(long tag,
             int length,
             int format,
             int schema,
             int version,
             int address,
             int cluster,
             int element)

Method Detail

getTag

public long getTag()

Gets the image tag.

Returns:

The tag for the image

getLength

public int getLength()

Gets the image length.

Returns:

The number of pixels in the image's pixel data.

getFormat

public int getFormat()

Gets the image format.

Returns:

The format (enumerated) of the data sent from the RCM.

getSchema

public int getSchema()

Gets the firmware schema.

Returns:

The data schema of the firmware producing the image.

getVersion

public int getVersion()

Gets the firmware version.

Returns:

The version of the firmware producing the image.

getAddress

public int getAddress()

Gets the RCM address.

Returns:

The address of the RCM producing the image.

getCluster

public int getCluster()

Gets the CPU cluster number.

Returns:

The cluster number of the CPU (RCE) producing the image.

getElement

public int getElement()

Gets the CPU element number.

Returns:

The element number of the CPU (RCE) producing the image.

toString

public String toString()

Gets the string representation.

Overrides:

toString in class Object

Returns:

The string representation of the metadata