org.lsst.ccs.daq.ims

Class ImageMetaData

java.lang.Object

org.lsst.ccs.daq.ims.ImageMetaData

All Implemented Interfaces:

Serializable

public class ImageMetaData
extends Object
implements Serializable

Meta-data associated with an image.

Author:

tonyj

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageMetaData(String imageName, String creationFolder, String annotation, int opcode, Set<org.lsst.ccs.utilities.location.Location> locationSet) A constructor to be used when creating new images to be written into the Store or when triggering the camera

Method Summary

Modifier and Type	Method and Description
String	getAnnotation() Get the annotation associated with the image when it was created.
String	getCreationFolderName() Get the folder in which the image was originally created
long	getId() The opaque id associated with the image by the DAQ.
Set<org.lsst.ccs.utilities.location.Location>	getLocations() Get the set of locations (REBs) associated with this image
String	getName() Get the image name.
int	getOpcode() Get the opcode associated with this image.
Version	getRelease() Get the DAQ release which created this image.
Instant	getTimestamp() Get the timestamp associated with this image.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMetaData

public ImageMetaData(String imageName,
                     String creationFolder,
                     String annotation,
                     int opcode,
                     Set<org.lsst.ccs.utilities.location.Location> locationSet)

A constructor to be used when creating new images to be written into the Store or when triggering the camera

Parameters:

imageName - The name of the newly created image.

creationFolder - The folder in which the image was originally created.

annotation - An annotation string to be associated with the image.

opcode - The "opcode" associated with the image. This normally corresponds to the index of the main routine in the sequencer which created this image.

locationSet - The set of locations to be associated with the image. After creating the imaqe a Source should be added for each location specified in the locationSet.

See Also:

Folder.insert(ImageMetaData), Image.addSource(Location, int[])

Method Detail

getName

public String getName()

Get the image name.

Returns:

The name.

getAnnotation

public String getAnnotation()

Get the annotation associated with the image when it was created.

Returns:

The annotation

getRelease

public Version getRelease()

Get the DAQ release which created this image.

Returns:

The DAQ version

getOpcode

public int getOpcode()

Get the opcode associated with this image. This normally corresponds to the index of the main routine in the sequencer which created this image.

Returns:

The opcode.

getTimestamp

public Instant getTimestamp()

Get the timestamp associated with this image.

Returns:

The timestamp

getLocations

public Set<org.lsst.ccs.utilities.location.Location> getLocations()

Get the set of locations (REBs) associated with this image

Returns:

getId

public long getId()

The opaque id associated with the image by the DAQ.

Returns:

The id

getCreationFolderName

public String getCreationFolderName()

Get the folder in which the image was originally created

Returns:

The image creation folder name

toString

public String toString()

Overrides:

toString in class Object