org.jscience.ml.om
Class CCDImager

java.lang.Object
  extended by org.jscience.ml.om.SchemaElement
      extended by org.jscience.ml.om.Imager
          extended by org.jscience.ml.om.CCDImager
All Implemented Interfaces:
IImager, ISchemaElement

public class CCDImager
extends Imager

Describes a CCD camera.

Since:
1.3

Field Summary
static java.lang.String XML_ELEMENT_XPIXELS
          Constant for XML representation: pixels on x axis
static java.lang.String XML_ELEMENT_YPIXELS
          Constant for XML representation: pixels on y axis
 
Fields inherited from interface org.jscience.ml.om.IImager
CCD, FILM, XML_ELEMENT_IMAGER, XML_ELEMENT_MODEL, XML_ELEMENT_REMARKS, XML_ELEMENT_TYPE, XML_ELEMENT_VENDOR
 
Fields inherited from interface org.jscience.ml.om.ISchemaElement
XML_ELEMENT_ATTRIBUTE_ID
 
Constructor Summary
CCDImager(org.w3c.dom.Node imagerElement)
          Constructs a new instance of a CCDImager from a given DOM target Element.
CCDImager(java.lang.String model, int xPixels, int yPixels)
          Constructs a new instance of a CCDImager.
 
Method Summary
 org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
          Adds this IImager to a given parent XML DOM Element.
 int getXPixels()
          Returns the amount of pixels on the x axis.
 int getYPixels()
          Returns the amount of pixels on the y axis.
 void setXPixels(int pixels)
          Sets the amount of pixels on the x axis.
 void setYPixels(int pixels)
          Sets the amount of pixels on the y axis.
 
Methods inherited from class org.jscience.ml.om.Imager
addAsLinkToXmlElement, createXmlImagerElement, equals, getDisplayName, getModel, getRemarks, getType, getVendor, setModel, setRemarks, setType, setVendor
 
Methods inherited from class org.jscience.ml.om.SchemaElement
getID, setID
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jscience.ml.om.ISchemaElement
getID
 

Field Detail

XML_ELEMENT_XPIXELS

public static final java.lang.String XML_ELEMENT_XPIXELS
Constant for XML representation: pixels on x axis

See Also:
Constant Field Values

XML_ELEMENT_YPIXELS

public static final java.lang.String XML_ELEMENT_YPIXELS
Constant for XML representation: pixels on y axis

See Also:
Constant Field Values
Constructor Detail

CCDImager

public CCDImager(org.w3c.dom.Node imagerElement)
          throws SchemaException
Constructs a new instance of a CCDImager from a given DOM target Element.
Normally this constructor is called by a child class which itself was called by org.jscience.ml.om.util.SchemaLoader.

Parameters:
imagerElement - The origin XML DOM Element
Throws:
SchemaException - if given imagerElement was null

CCDImager

public CCDImager(java.lang.String model,
                 int xPixels,
                 int yPixels)
Constructs a new instance of a CCDImager.

Parameters:
model - The model name
xPixels - The amount of pixel on the x axis
yPixels - The amount of pixel on the y axis
Throws:
SchemaException - if given model was null, or on of the pixel values was <= 0.
Method Detail

addToXmlElement

public org.w3c.dom.Element addToXmlElement(org.w3c.dom.Element element)
Description copied from class: Imager
Adds this IImager to a given parent XML DOM Element. The IImager element will be set as a child element of the passed element.

Specified by:
addToXmlElement in interface IImager
Specified by:
addToXmlElement in class Imager
Parameters:
element - The parent element for this IImager
Returns:
Returns the element given as parameter with this IImager as child element.
* Might return null if parent was null.
See Also:
Element

getXPixels

public int getXPixels()
Returns the amount of pixels on the x axis.

Returns:
Returns amount of pixels on the x axis

setXPixels

public void setXPixels(int pixels)
                throws java.lang.IllegalArgumentException
Sets the amount of pixels on the x axis.

Parameters:
pixels - The new amount of pixel on the x axis
Throws:
java.lang.IllegalArgumentException - if given pixels are <= 0

getYPixels

public int getYPixels()
Returns the amount of pixels on the y axis.

Returns:
Returns amount of pixels on the y axis

setYPixels

public void setYPixels(int pixels)
Sets the amount of pixels on the y axis.

Parameters:
pixels - The new amount of pixel on the y axis
Throws:
java.lang.IllegalArgumentException - if given pixels are <= 0