HiRISE.HiPlan.IO
Class PTF_Record

java.lang.Object
  HiRISE.HiPlan.IO.PTF_Record

All Implemented Interfaces:

PTF_Fields, Cloneable

Deprecated. As of HiPlan 2.12.2, replaced by PTF_Record.

public class PTF_Record
extends Object
implements PTF_Fields, Cloneable

A single observation from a payload target file (PTF). This class is tailored towards HiRISE use, in that rules from the PTF software interface specification (SIS) that apply to HiRISE are checked, and those that do not are ignored.

The PTF record fields are not allowed to be null. If a field contains no value, it is the empty string, not a null. Any attempt to set a field value to null will silently set it to the empty string instead.

Note: This class has been moved to the HiRISE.HiPlan.PTF package. It remains here, deprecated, for backwards compatibility.

Version:

1.2

Author:

Christian Schaller - UA/PIRL

See Also:

"Payload Target File and Integrated Payload Target File Software Interface Specification (JPL MRO SEQ032)"

Field Summary

static String

ID Deprecated. Class identification name with source code version and date.

Fields inherited from interface HiRISE.HiPlan.IO.PTF_Fields

ANCILLARY_DATA, COMMENT, COMPRESSION, COORDINATED_TRACK_HISTORY, DOWNLINK_PRIORITY, ELEVATION, FIELD_COUNT, FIELD_NAMES, INSTRUMENT_SET, INSTRUMENT_SPARE_FIELD_1, INSTRUMENT_SPARE_FIELD_2, INSTRUMENT_SPARE_FIELD_3, INSTRUMENT_SPARE_FIELD_4, LATITUDE, LONGITUDE, LSUBS, OBSERVATION_DURATION, OBSERVATION_MODE, OBSERVATION_TYPE, ORBIT_ALTERNATIVES, ORBIT_NUMBER, ORBITAL_DATA_TABLE, PARAMETERS_TABLE, PIXEL_SCALE, PREDICT_TIME, PRODUCT_ID, RAW_DATA_VOLUME, REQUEST_CATEGORY, REQUEST_PRIORITY, ROLL_ANGLE, SEQUENCE_FILENAME, SETUP_DURATION, TEAM_DATABASE_ID

Constructor Summary

PTF_Record()
Deprecated. Creates a new PTF record with empty fields.

PTF_Record(String ptf_record_text)
Deprecated. Creates a new PTF record using field values derived from an input comma-separated text record.

Method Summary

String	ancillary_data() Deprecated. Gets the ancillary data for this observation.
void	ancillary_data(String ancillary_data) Deprecated. Sets the ancillary data for this observation.
Object	clone() Deprecated. Returns a clone of this PTF record.
String	comment() Deprecated. Gets the comment for this observation.
void	comment(String comment) Deprecated. Sets the comment for this observation.
String	compression() Deprecated. Gets the compression for this observation.
void	compression(String compression) Deprecated. Sets the compression for this observation.
String	coordinated_track_history() Deprecated. Gets the coordinated track history for this observation.
void	coordinated_track_history(String coordinated_track_history) Deprecated. Sets the coordinated track history for this observation.
String	downlink_priority() Deprecated. Gets the downlink priority for this observation.
void	downlink_priority(String downlink_priority) Deprecated. Sets the downlink priority for this observation.
String	elevation() Deprecated. Gets the elevation for this observation.
void	elevation(String elevation) Deprecated. Sets the elevation for this observation.
static int	field_index(String field) Deprecated. Gets the index of field in the PTF_Fields.FIELD_NAMES array.
String	instrument_set() Deprecated. Gets the instrument set for this observation.
void	instrument_set(String instrument_set) Deprecated. Sets the instrument set for this observation.
String	instrument_spare_field_1() Deprecated. Gets the instrument spare field 1 for this observation.
void	instrument_spare_field_1(String instrument_spare_field_1) Deprecated. Sets the instrument spare field 1 for this observation.
String	instrument_spare_field_2() Deprecated. Gets the instrument spare field 2 for this observation.
void	instrument_spare_field_2(String instrument_spare_field_2) Deprecated. Sets the instrument spare field 2 for this observation.
String	instrument_spare_field_3() Deprecated. Gets the instrument spare field 3 for this observation.
void	instrument_spare_field_3(String instrument_spare_field_3) Deprecated. Sets the instrument spare field 3 for this observation.
String	instrument_spare_field_4() Deprecated. Gets the instrument spare field 4 for this observation.
void	instrument_spare_field_4(String instrument_spare_field_4) Deprecated. Sets the instrument spare field 4 for this observation.
String	latitude() Deprecated. Gets the latitude for this observation.
void	latitude(String latitude) Deprecated. Sets the latitude for this observation.
String	longitude() Deprecated. Gets the longitude for this observation.
void	longitude(String longitude) Deprecated. Sets the longitude for this observation.
String	lsubs() Deprecated. Gets the lsubs for this observation.
void	lsubs(String lsubs) Deprecated. Sets the lsubs for this observation.
String	observation_duration() Deprecated. Gets the observation duration for this observation.
void	observation_duration(String observation_duration) Deprecated. Sets the observation duration for this observation.
String	observation_mode() Deprecated. Gets the observation mode for this observation.
void	observation_mode(String observation_mode) Deprecated. Sets the observation mode for this observation.
String	observation_type() Deprecated. Gets the observation type for this observation.
void	observation_type(String observation_type) Deprecated. Sets the observation type for this observation.
String	orbit_alternatives() Deprecated. Gets the orbit alternatives for this observation.
void	orbit_alternatives(String orbit_alternatives) Deprecated. Sets the orbit alternatives for this observation.
String	orbit_number() Deprecated. Gets the orbit number for this observation.
void	orbit_number(String orbit_number) Deprecated. Sets the orbit number for this observation.
String	orbital_data_table() Deprecated. Gets the orbital data table for this observation.
void	orbital_data_table(String orbital_data_table) Deprecated. Sets the orbital data table for this observation.
String	parameters_table() Deprecated. Gets the parameters table for this observation.
void	parameters_table(String parameters_table) Deprecated. Sets the parameters table for this observation.
String	pixel_scale() Deprecated. Gets the pixel scale for this observation.
void	pixel_scale(String pixel_scale) Deprecated. Sets the pixel scale for this observation.
String	predict_time() Deprecated. Gets the predict time for this observation.
void	predict_time(String predict_time) Deprecated. Sets the predict time for this observation.
String	product_id() Deprecated. Gets the product ID for this observation.
void	product_id(String product_id) Deprecated. Sets the product ID for this observation.
String	pvl_text() Deprecated. Gets a text representation of this PTF record in PVL form with an indent level of 0.
String	pvl_text(int indent_level) Deprecated. Gets a text representation of this PTF record in PVL form.
String	raw_data_volume() Deprecated. Gets the raw data volume in megabits for this observation.
void	raw_data_volume(String raw_data_volume) Deprecated. Sets the raw data volume for this observation.
String	request_category() Deprecated. Gets the request category for this observation.
void	request_category(String request_category) Deprecated. Sets the request category for this observation.
String	request_priority() Deprecated. Gets the request priority for this observation.
void	request_priority(String request_priority) Deprecated. Sets the request priority for this observation.
String	roll_angle() Deprecated. Gets the roll angle for this observation.
void	roll_angle(String roll_angle) Deprecated. Sets the roll angle for this observation.
String	sequence_filename() Deprecated. Gets the sequence filename for this observation's command file.
String	setup_duration() Deprecated. Gets the setup duration for this observation.
void	setup_duration(String setup_duration) Deprecated. Sets the setup duration for this observation.
String	team_database_id() Deprecated. Gets the team database id for this observation.
void	team_database_id(String team_database_id) Deprecated. Sets the team database id for this observation.
static Vector	tokenize(String text) Deprecated. Produces a vector of strings from comma-separated value text.
String	toString() Deprecated. Gets a string representation of this PTF record.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

Deprecated.

Class identification name with source code version and date.

See Also:

Constant Field Values

Constructor Detail

PTF_Record

public PTF_Record()

Deprecated.

Creates a new PTF record with empty fields.

PTF_Record

public PTF_Record(String ptf_record_text)
           throws Invalid_Argument_Exception

Deprecated.

Creates a new PTF record using field values derived from an input comma-separated text record. If the text does not contain enough fields, an Invalid_Argument_Exception is thrown.

Parameters:

ptf_record_text - the comma-separated text representation of the PTF record.

Throws:

Invalid_Argument_Exception - if the input text is not a valid PTF record.

Method Detail

instrument_set

public String instrument_set()

Deprecated.

Gets the instrument set for this observation.

Returns:

the instrument set.

instrument_set

public void instrument_set(String instrument_set)

Deprecated.

Sets the instrument set for this observation. Some fields must be "blank" (the empty string) if the instrument set indicates a HiRISE observation. A HiRISE observation is one in which the first character of the instrument set is "H." In this case, the orbital_data_table(), parameters_table(), and product_id() will be set to the empty string.

Parameters:

instrument_set - the new instrument set.

predict_time

public String predict_time()

Deprecated.

Gets the predict time for this observation.

Returns:

the predict time.

predict_time

public void predict_time(String predict_time)

Deprecated.

Sets the predict time for this observation.

Parameters:

predict_time - the new predict time.

latitude

public String latitude()

Deprecated.

Gets the latitude for this observation.

Returns:

the latitude.

latitude

public void latitude(String latitude)

Deprecated.

Sets the latitude for this observation.

Parameters:

latitude - the new latitude.

longitude

public String longitude()

Deprecated.

Gets the longitude for this observation.

Returns:

the longitude.

longitude

public void longitude(String longitude)

Deprecated.

Sets the longitude for this observation.

Parameters:

longitude - the new longitude.

elevation

public String elevation()

Deprecated.

Gets the elevation for this observation.

Returns:

the elevation.

elevation

public void elevation(String elevation)

Deprecated.

Sets the elevation for this observation.

Parameters:

elevation - the new elevation.

observation_type

public String observation_type()

Deprecated.

Gets the observation type for this observation.

Returns:

the observation type.

observation_type

public void observation_type(String observation_type)

Deprecated.

Sets the observation type for this observation.

Parameters:

observation_type - the new observation type.

orbit_number

public String orbit_number()

Deprecated.

Gets the orbit number for this observation.

Returns:

the orbit number.

orbit_number

public void orbit_number(String orbit_number)

Deprecated.

Sets the orbit number for this observation.

Parameters:

orbit_number - the new orbit number.

orbit_alternatives

public String orbit_alternatives()

Deprecated.

Gets the orbit alternatives for this observation.

Returns:

the orbit alternatives.

orbit_alternatives

public void orbit_alternatives(String orbit_alternatives)

Deprecated.

Sets the orbit alternatives for this observation.

Parameters:

orbit_alternatives - the new orbit alternatives.

observation_duration

public String observation_duration()

Deprecated.

Gets the observation duration for this observation.

Returns:

the observation duration.

observation_duration

public void observation_duration(String observation_duration)

Deprecated.

Sets the observation duration for this observation.

Parameters:

observation_duration - the new observation duration.

setup_duration

public String setup_duration()

Deprecated.

Gets the setup duration for this observation.

Returns:

the setup duration.

setup_duration

public void setup_duration(String setup_duration)

Deprecated.

Sets the setup duration for this observation.

Parameters:

setup_duration - the new setup duration.

orbital_data_table

public String orbital_data_table()

Deprecated.

Gets the orbital data table for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

Returns:

the orbital data table.

orbital_data_table

public void orbital_data_table(String orbital_data_table)
                        throws Invalid_Argument_Exception

Deprecated.

Sets the orbital data table for this observation. For HiRISE observations, the value of orbital_data_table must always be the empty string or null (in which case the orbital data tabe will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

Parameters:

orbital_data_table - the new orbital data table.

Throws:

Invalid_Argument_Exception - if the observation is for HiRISE and orbital_data_table is not null or the empty string.

parameters_table

public String parameters_table()

Deprecated.

Gets the parameters table for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

Returns:

the parameters table.

parameters_table

public void parameters_table(String parameters_table)
                      throws Invalid_Argument_Exception

Deprecated.

Sets the parameters table for this observation. For HiRISE observations, the value of parameters_table must always be the empty string or null (in which case the orbital data tabe will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

Parameters:

parameters_table - the new parameters table.

Throws:

Invalid_Argument_Exception - if the observation is for HiRISE and parameters_table is not null or the empty string.

sequence_filename

public String sequence_filename()

Deprecated.

Gets the sequence filename for this observation's command file. The sequence filename is the name under which the command file (the sequence) is stored on the MRO fielsystem. If this observation's ID is a formal Observation_ID, this method returns a proper filename. If not, it returns Instrument.NOT_APPLICABLE_STRING.

This method has no matching writer/setter. The value for the sequence filename is entirely derived from the observation ID (team database ID).

downlink_priority

public String downlink_priority()

Deprecated.

Gets the downlink priority for this observation.

Returns:

the downlink priority.

downlink_priority

public void downlink_priority(String downlink_priority)

Deprecated.

Sets the downlink priority for this observation.

Parameters:

downlink_priority - the new downlink priority.

product_id

public String product_id()

Deprecated.

Gets the product ID for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

The product ID should not be confused with the HiRISE observation ID. The latter is found in the team_database_id() field.

Returns:

the product ID.

product_id

public void product_id(String product_id)
                throws Invalid_Argument_Exception

Deprecated.

Sets the product ID for this observation. For HiRISE observations, the value of product_id must always be the empty string or null (in which case the product ID will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set() is "H."

The product ID should not be confused with the HiRISE observation ID. The latter is found in the team_database_id() field.

Parameters:

product_id - the new product ID.

Throws:

Invalid_Argument_Exception - if the observation is for HiRISE and product_id is not null or the empty string.

instrument_spare_field_1

public String instrument_spare_field_1()

Deprecated.

Gets the instrument spare field 1 for this observation.

Returns:

the instrument spare field 1.

instrument_spare_field_1

public void instrument_spare_field_1(String instrument_spare_field_1)

Deprecated.

Sets the instrument spare field 1 for this observation.

Parameters:

instrument_spare_field_1 - the new instrument spare field 1.

instrument_spare_field_2

public String instrument_spare_field_2()

Deprecated.

Gets the instrument spare field 2 for this observation.

Returns:

the instrument spare field 2.

instrument_spare_field_2

public void instrument_spare_field_2(String instrument_spare_field_2)

Deprecated.

Sets the instrument spare field 2 for this observation.

Parameters:

instrument_spare_field_2 - the new instrument spare field 2.

instrument_spare_field_3

public String instrument_spare_field_3()

Deprecated.

Gets the instrument spare field 3 for this observation.

Returns:

the instrument spare field 3.

instrument_spare_field_3

public void instrument_spare_field_3(String instrument_spare_field_3)

Deprecated.

Sets the instrument spare field 3 for this observation.

Parameters:

instrument_spare_field_3 - the new instrument spare field 3.

instrument_spare_field_4

public String instrument_spare_field_4()

Deprecated.

Gets the instrument spare field 4 for this observation.

Returns:

the instrument spare field 4.

instrument_spare_field_4

public void instrument_spare_field_4(String instrument_spare_field_4)

Deprecated.

Sets the instrument spare field 4 for this observation.

Parameters:

instrument_spare_field_4 - the new instrument spare field 4.

comment

public String comment()

Deprecated.

Gets the comment for this observation. The comment will already have been escaped.

Returns:

the comment.

comment

public void comment(String comment)

Deprecated.

Sets the comment for this observation. The comment will be escaped as appropriate.

Parameters:

comment - the new comment.

request_priority

public String request_priority()

Deprecated.

Gets the request priority for this observation.

Returns:

the request priority.

request_priority

public void request_priority(String request_priority)

Deprecated.

Sets the request priority for this observation.

Parameters:

request_priority - the new request priority.

coordinated_track_history

public String coordinated_track_history()

Deprecated.

Gets the coordinated track history for this observation.

Returns:

the status.

coordinated_track_history

public void coordinated_track_history(String coordinated_track_history)

Deprecated.

Sets the coordinated track history for this observation.

Parameters:

coordinated_track_history - the new coordinated track history.

raw_data_volume

public String raw_data_volume()

Deprecated.

Gets the raw data volume in megabits for this observation.

Returns:

the raw data volume.

raw_data_volume

public void raw_data_volume(String raw_data_volume)

Deprecated.

Sets the raw data volume for this observation.

Parameters:

raw_data_volume - the new raw data volume in megabits.

team_database_id

public String team_database_id()

Deprecated.

Gets the team database id for this observation.

Returns:

the team database id.

team_database_id

public void team_database_id(String team_database_id)

Deprecated.

Sets the team database id for this observation.

Parameters:

team_database_id - the new team database id.

request_category

public String request_category()

Deprecated.

Gets the request category for this observation.

Returns:

the request category.

request_category

public void request_category(String request_category)

Deprecated.

Sets the request category for this observation.

Parameters:

request_category - the new request category.

compression

public String compression()

Deprecated.

Gets the compression for this observation.

Returns:

the compression.

compression

public void compression(String compression)

Deprecated.

Sets the compression for this observation.

Parameters:

compression - the new compression.

pixel_scale

public String pixel_scale()

Deprecated.

Gets the pixel scale for this observation.

Returns:

the pixel scale.

pixel_scale

public void pixel_scale(String pixel_scale)

Deprecated.

Sets the pixel scale for this observation.

Parameters:

pixel_scale - the new pixel scale.

observation_mode

public String observation_mode()

Deprecated.

Gets the observation mode for this observation.

Returns:

the observation mode.

observation_mode

public void observation_mode(String observation_mode)

Deprecated.

Sets the observation mode for this observation.

Parameters:

observation_mode - the new observation mode.

ancillary_data

public String ancillary_data()

Deprecated.

Gets the ancillary data for this observation.

Returns:

the ancillary data.

ancillary_data

public void ancillary_data(String ancillary_data)

Deprecated.

Sets the ancillary data for this observation.

Parameters:

ancillary_data - the new ancillary data.

lsubs

public String lsubs()

Deprecated.

Gets the lsubs for this observation.

Returns:

the lsubs.

lsubs

public void lsubs(String lsubs)

Deprecated.

Sets the lsubs for this observation.

Parameters:

lsubs - the new lsubs.

roll_angle

public String roll_angle()

Deprecated.

Gets the roll angle for this observation.

Returns:

the roll angle.

roll_angle

public void roll_angle(String roll_angle)

Deprecated.

Sets the roll angle for this observation.

Parameters:

roll_angle - the new roll angle.

clone

public Object clone()

Deprecated.

Returns a clone of this PTF record. The copy contains a reference to a clone of the internal data, not a reference to the original internal data of this PTF_Record.

Overrides:

clone in class Object

Returns:

a clone of this PTF record.

toString

public String toString()

Deprecated.

Gets a string representation of this PTF record.

Overrides:

toString in class Object

Returns:

the string representation.

pvl_text

public String pvl_text(int indent_level)

Deprecated.

Gets a text representation of this PTF record in PVL form. The text may be used in a PVL Parser to create a Parameter. The text is created as a group aggregate with the name "PTF_Record." The parameter names are taken from the PTF SIS; they are entirely uppercase, however, and space have been replaced with underscores.

Parameters:

indent_level - the number of tabs to use for the top level indent.

Returns:

the PVL text.

pvl_text

public String pvl_text()

Deprecated.

Gets a text representation of this PTF record in PVL form with an indent level of 0.

Returns:

the PVL text.

See Also:

pvl_text(int)

tokenize

public static Vector tokenize(String text)

Deprecated.

Produces a vector of strings from comma-separated value text. Commas may be escaped by being preceded by the '\' character.

Parameters:

text - the comma-separated value text.

Returns:

a vector of strings.

field_index

public static int field_index(String field)

Deprecated.

Gets the index of field in the PTF_Fields.FIELD_NAMES array. If field is not a valid field name, a -1 is returned instead. The test is done in a case-insensitive manner.

Parameters:

field - the putative field name.

Returns:

the field index or -1 if it is not a valid field or is null.