nom.tam.fits

Class HeaderCard

java.lang.Object

nom.tam.fits.HeaderCard

public class HeaderCard
extends java.lang.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(java.lang.String card) Create a HeaderCard from a FITS card image
HeaderCard(java.lang.String key, boolean value, java.lang.String comment) Create a HeaderCard from its component parts
HeaderCard(java.lang.String key, double value, java.lang.String comment) Create a HeaderCard from its component parts
HeaderCard(java.lang.String key, int value, java.lang.String comment) Create a HeaderCard from its component parts
HeaderCard(java.lang.String key, long value, java.lang.String comment) Create a HeaderCard from its component parts
HeaderCard(java.lang.String key, java.lang.String comment, boolean nullable) Create a comment style card.
HeaderCard(java.lang.String key, java.lang.String value, java.lang.String comment) Create a HeaderCard from its component parts
HeaderCard(java.lang.String key, java.lang.String value, java.lang.String comment, boolean nullable) Create a HeaderCard from its component parts

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getComment() Return the comment from this card
java.lang.String	getKey() Return the keyword from this card
java.lang.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?
void	setValue(java.lang.String update) Set the value for this card.
java.lang.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(java.lang.String key,
          double value,
          java.lang.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(java.lang.String key,
          boolean value,
          java.lang.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(java.lang.String key,
          int value,
          java.lang.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(java.lang.String key,
          long value,
          java.lang.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(java.lang.String key,
          java.lang.String value,
          java.lang.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(java.lang.String key,
          java.lang.String comment,
          boolean nullable)
           throws HeaderCardException

Create a comment style card. This constructor builds a card which has no value. This may be either a comment style card in which case the nullable field should be false, or a value field which has a null value, in which case the nullable field should be true.

Parameters:

key - The key for the comment or nullable field.

comment - The comment

nullable - Is this a nullable field or a comment-style card?

Throws:

HeaderCardException

HeaderCard

public HeaderCard(java.lang.String key,
          java.lang.String value,
          java.lang.String comment,
          boolean nullable)
           throws HeaderCardException

Create a HeaderCard from its component parts

Parameters:

key - Keyword (null for a COMMENT)

value - Value

comment - Comment

nullable - Is this a nullable value card?

Throws:

HeaderCardException - for any invalid keyword or value

HeaderCard

public HeaderCard(java.lang.String card)

Create a HeaderCard from a FITS card image

Parameters:

card - the 80 character card image

Method Detail

isStringValue

public boolean isStringValue()

Does this card contain a string value?

isKeyValuePair

public boolean isKeyValuePair()

Is this a key/value card?

getKey

public java.lang.String getKey()

Return the keyword from this card

getValue

public java.lang.String getValue()

Return the value from this card

setValue

public void setValue(java.lang.String update)

Set the value for this card.

getComment

public java.lang.String getComment()

Return the comment from this card

toString

public java.lang.String toString()

Return the 80 character card image

Overrides:

toString in class java.lang.Object