nom.tam.fits

Class HeaderCard

java.lang.Object

nom.tam.fits.HeaderCard

public class HeaderCard
extends Object

This class describes methods to access and manipulate the individual cards for a FITS Header.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_KEYWORD_LENGTH Maximum length of a FITS keyword field
static int	MAX_VALUE_LENGTH Maximum length of a FITS value field

Constructor Summary

Constructors

Constructor and Description
HeaderCard(String card) Create a HeaderCard from a FITS card image
HeaderCard(String key, boolean value, String comment) Create a HeaderCard from its component parts
HeaderCard(String key, double value, String comment) Create a HeaderCard from its component parts
HeaderCard(String key, int value, String comment)
HeaderCard(String key, long value, String comment)
HeaderCard(String key, String value, String comment) Create a HeaderCard from its component parts

Method Summary

Modifier and Type	Method and Description
static HeaderCard	create(String card) Creates a HeaderCard from a FITS card image.
String	getComment() Return the comment from this card
String	getKey() Return the keyword from this card
String	getValue() Return the value from this card
boolean	isKeyValuePair() Is this a key/value card?
boolean	isStringValue() Does this card contain a string value?
String	toString() Return the 80 character card image

Methods inherited from class java.lang.Object

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

Field Detail

MAX_KEYWORD_LENGTH

public static final int MAX_KEYWORD_LENGTH

Maximum length of a FITS keyword field

See Also:

Constant Field Values

MAX_VALUE_LENGTH

public static final int MAX_VALUE_LENGTH

Maximum length of a FITS value field

See Also:

Constant Field Values

Constructor Detail

HeaderCard

public HeaderCard(String key,
                  double value,
                  String comment)
           throws HeaderCardException

Create a HeaderCard from its component parts

Parameters:

key - keyword (null for a comment)

value - value (null for a comment or keyword without an '=')

comment - comment

Throws:

HeaderCardException - for any invalid keyword

HeaderCard

public HeaderCard(String key,
                  boolean value,
                  String comment)
           throws HeaderCardException

Create a HeaderCard from its component parts

Parameters:

key - keyword (null for a comment)

value - value (null for a comment or keyword without an '=')

comment - comment

Throws:

HeaderCardException - for any invalid keyword

HeaderCard

public HeaderCard(String key,
                  int value,
                  String comment)
           throws HeaderCardException

Throws:

HeaderCardException

HeaderCard

public HeaderCard(String key,
                  long value,
                  String comment)
           throws HeaderCardException

Throws:

HeaderCardException

HeaderCard

public HeaderCard(String key,
                  String value,
                  String comment)
           throws HeaderCardException

Create a HeaderCard from its component parts

Parameters:

key - keyword (null for a comment)

value - value (null for a comment or keyword without an '=')

comment - comment

Throws:

HeaderCardException - for any invalid keyword or value

HeaderCard

public HeaderCard(String card)

Create a HeaderCard from a FITS card image

Parameters:

card - the 80 character card image

Method Detail

create

public static HeaderCard create(String card)

Creates a HeaderCard from a FITS card image. This just invokes the HeaderCard(java.lang.String) constructor. It is here to match a method with the same signature from later versions of nom.tam.fits (which lack the corresponding constructor).

Parameters:

card - the 80 character card image

isStringValue

public boolean isStringValue()

Does this card contain a string value?

isKeyValuePair

public boolean isKeyValuePair()

Is this a key/value card?

getKey

public String getKey()

Return the keyword from this card

getValue

public String getValue()

Return the value from this card

getComment

public String getComment()

Return the comment from this card

toString

public String toString()

Return the 80 character card image

Overrides:

toString in class Object