public class PTF_Record
extends java.lang.Object
implements java.lang.Cloneable
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CRM_INSTRUMENT_CODE
The CRISM instrument code.
|
static java.lang.String |
CTX_INSTRUMENT_CODE
The CTX instrument code.
|
static java.lang.String |
ELE_INSTRUMENT_CODE
The ELECTRA instrument code.
|
static java.lang.String |
HIR_INSTRUMENT_CODE
The HiRISE instrument code.
|
static java.lang.String |
HIR_SEQUENCE_FILENAME_PREFIX
The prefix for a HiRISE observation sequence filename.
|
static java.lang.String |
HIR_SEQUENCE_FILENAME_SUFFIX
The suffix for a HiRISE observation sequence filename.
|
static java.lang.String |
ID
Class identification name with source code version and date.
|
static java.lang.String |
MAR_INSTRUMENT_CODE
The MARCI instrument code.
|
static java.lang.String |
SHA_INSTRUMENT_CODE
The SHARAD instrument code.
|
Constructor and Description |
---|
PTF_Record()
Creates a new PTF record with empty fields.
|
PTF_Record(Observation_Record observation_record)
Creates a new PTF record using field values from an input observation
record.
|
PTF_Record(java.lang.String ptf_record_text)
Creates a new PTF record using field values derived from an input
comma-separated text record.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
ancillary_data()
Gets the ancillary data for this observation.
|
void |
ancillary_data(java.lang.String ancillary_data)
Sets the ancillary data for this observation.
|
java.lang.Object |
clone()
Returns a clone of this PTF record.
|
java.lang.String |
comment()
Gets the comment for this observation.
|
void |
comment(java.lang.String comment)
Sets the comment for this observation.
|
java.lang.String |
compression()
Gets the compression for this observation.
|
void |
compression(java.lang.String compression)
Sets the compression for this observation.
|
java.lang.String |
coordinated_track_history()
Gets the coordinated track history for this observation.
|
void |
coordinated_track_history(java.lang.String coordinated_track_history)
Sets the coordinated track history for this observation.
|
java.lang.String |
downlink_priority()
Gets the downlink priority for this observation.
|
void |
downlink_priority(java.lang.String downlink_priority)
Sets the downlink priority for this observation.
|
java.lang.String |
elevation()
Gets the elevation for this observation.
|
void |
elevation(java.lang.Double elevation)
Sets the elevation for this observation.
|
void |
elevation(java.lang.String elevation)
Sets the elevation for this observation.
|
boolean |
equals(java.lang.Object o)
Indicates whether some other object is "equal to" this one.
|
int |
hashCode()
Returns a hash code value for this PTF record.
|
java.lang.String |
instrument_set()
Gets the instrument set for this observation.
|
void |
instrument_set(java.lang.String instrument_set)
Sets the instrument set for this observation.
|
java.lang.String |
instrument_spare_field_1()
Gets the instrument spare field 1 for this observation.
|
void |
instrument_spare_field_1(java.lang.Double instrument_spare_field_1)
Sets the instrument spare field 1 for this observation.
|
void |
instrument_spare_field_1(java.lang.String instrument_spare_field_1)
Sets the instrument spare field 1 for this observation.
|
java.lang.String |
instrument_spare_field_2()
Gets the instrument spare field 2 for this observation.
|
void |
instrument_spare_field_2(java.lang.Double instrument_spare_field_2)
Sets the instrument spare field 2 for this observation.
|
void |
instrument_spare_field_2(java.lang.String instrument_spare_field_2)
Sets the instrument spare field 2 for this observation.
|
java.lang.String |
instrument_spare_field_3()
Gets the instrument spare field 3 for this observation.
|
void |
instrument_spare_field_3(java.lang.Integer instrument_spare_field_3)
Sets the instrument spare field 3 for this observation.
|
void |
instrument_spare_field_3(java.lang.String instrument_spare_field_3)
Sets the instrument spare field 3 for this observation.
|
java.lang.String |
instrument_spare_field_4()
Gets the instrument spare field 4 for this observation.
|
void |
instrument_spare_field_4(java.lang.String instrument_spare_field_4)
Sets the instrument spare field 4 for this observation.
|
java.lang.String |
latitude()
Gets the latitude for this observation.
|
void |
latitude(java.lang.Double latitude)
Sets the latitude for this observation.
|
void |
latitude(java.lang.String latitude)
Sets the latitude for this observation.
|
java.lang.String |
longitude()
Gets the longitude for this observation.
|
void |
longitude(java.lang.Double longitude)
Sets the longitude for this observation.
|
void |
longitude(java.lang.String longitude)
Sets the longitude for this observation.
|
java.lang.String |
lsubs()
Gets the lsubs for this observation.
|
void |
lsubs(java.lang.Double lsubs)
Sets the lsubs for this observation.
|
void |
lsubs(java.lang.String lsubs)
Sets the lsubs for this observation.
|
java.lang.String |
observation_duration()
Gets the observation duration for this observation.
|
void |
observation_duration(java.lang.Double observation_duration)
Sets the observation duration for this observation.
|
void |
observation_duration(java.lang.String observation_duration)
Sets the observation duration for this observation.
|
java.lang.String |
observation_mode()
Gets the observation mode for this observation.
|
void |
observation_mode(Observation_Record observation_record)
Sets the observation mode for this observation.
|
void |
observation_mode(java.lang.String observation_mode)
Sets the observation mode for this observation.
|
void |
observation_record(Observation_Record observation_record)
Sets the values for this PTF record to those from the given observation
record.
|
java.lang.String |
observation_type()
Gets the observation type for this observation.
|
void |
observation_type(java.lang.Integer observation_type)
Sets the observation type for this observation.
|
void |
observation_type(java.lang.String observation_type)
Sets the observation type for this observation.
|
java.lang.String |
orbit_alternatives()
Gets the orbit alternatives for this observation.
|
void |
orbit_alternatives(java.lang.String orbit_alternatives)
Sets the orbit alternatives for this observation.
|
java.lang.String |
orbit_number()
Gets the orbit number for this observation.
|
void |
orbit_number(java.lang.Integer orbit_number,
java.lang.String orbit_pass)
Sets the orbit number for this observation.
|
void |
orbit_number(java.lang.String orbit_number)
Sets the orbit number for this observation.
|
java.lang.String |
orbital_data_table()
Gets the orbital data table for this observation.
|
void |
orbital_data_table(java.lang.String orbital_data_table)
Sets the orbital data table for this observation.
|
PIRL.PVL.Parameter |
parameter()
Gets the PTF record are a PVL parameter.
|
java.lang.String |
parameters_table()
Gets the parameters table for this observation.
|
void |
parameters_table(java.lang.String parameters_table)
Sets the parameters table for this observation.
|
java.lang.String |
pixel_scale()
Gets the pixel scale for this observation.
|
void |
pixel_scale(java.lang.String pixel_scale)
Sets the pixel scale for this observation.
|
java.lang.String |
predict_time()
Gets the predict time for this observation.
|
void |
predict_time(java.lang.String predict_time)
Sets the predict time for this observation.
|
java.lang.String |
product_id()
Gets the product ID for this observation.
|
void |
product_id(java.lang.String product_id)
Sets the product ID for this observation.
|
java.lang.String |
raw_data_volume()
Gets the raw data volume in megabits for this observation.
|
void |
raw_data_volume(java.lang.Double raw_data_volume)
Sets the raw data volume for this observation.
|
void |
raw_data_volume(java.lang.String raw_data_volume)
Sets the raw data volume for this observation.
|
java.lang.String |
request_category()
Gets the request category for this observation.
|
void |
request_category(java.lang.String request_category)
Sets the request category for this observation.
|
java.lang.String |
request_priority()
Gets the request priority for this observation.
|
void |
request_priority(java.lang.Integer request_priority)
Sets the request priority for this observation.
|
void |
request_priority(java.lang.String request_priority)
Sets the request priority for this observation.
|
java.lang.String |
roll_angle()
Gets the roll angle for this observation.
|
void |
roll_angle(java.lang.Double roll_angle)
Sets the roll angle for this observation.
|
void |
roll_angle(java.lang.String roll_angle)
Sets the roll angle for this observation.
|
java.lang.String |
sequence_filename()
Gets the sequence filename for this observation's MRO sequence file.
|
java.lang.String |
sequence_filename(boolean generate_filename)
Gets the sequence filename for this observation's MRO sequence file,
optionally generating it from the HiRISE team database ID if applicable.
|
static java.lang.String |
sequence_filename(java.lang.String observation_id)
Generates an MRO sequence filename for a HiRISE observation command file.
|
java.lang.String |
setup_duration()
Gets the setup duration for this observation.
|
void |
setup_duration(java.lang.Double setup_duration)
Sets the setup duration for this observation.
|
void |
setup_duration(java.lang.String setup_duration)
Sets the setup duration for this observation.
|
java.lang.String |
team_database_id()
Gets the team database id for this observation.
|
void |
team_database_id(java.lang.String team_database_id)
Sets the team database id for this observation.
|
static java.util.List<java.lang.String> |
tokenize(java.lang.String text)
Produces a list of strings from comma-separated value text.
|
java.lang.String |
toString()
Gets a string representation of this PTF record.
|
public static final java.lang.String ID
public static final java.lang.String HIR_SEQUENCE_FILENAME_PREFIX
public static final java.lang.String HIR_SEQUENCE_FILENAME_SUFFIX
public static final java.lang.String HIR_INSTRUMENT_CODE
public static final java.lang.String CRM_INSTRUMENT_CODE
public static final java.lang.String CTX_INSTRUMENT_CODE
public static final java.lang.String MAR_INSTRUMENT_CODE
public static final java.lang.String SHA_INSTRUMENT_CODE
public static final java.lang.String ELE_INSTRUMENT_CODE
public PTF_Record()
public PTF_Record(java.lang.String ptf_record_text) throws Invalid_Argument_Exception
Invalid_Argument_Exception
is thrown. If it contains too few, empty
fields are added to fill out the record, as per the PTF SIS.ptf_record_text
- the comma-separated text representation of the PTF
record.Invalid_Argument_Exception
- if the input text is not a valid PTF
record.public PTF_Record(Observation_Record observation_record)
observation_record
- the observation record from which PTF record
field values are taken.public java.lang.String instrument_set()
public void instrument_set(java.lang.String instrument_set)
orbital_data_table
, parameters_table
, and product_id
will be set to the empty string.instrument_set
- the new instrument set.public java.lang.String predict_time()
public void predict_time(java.lang.String predict_time)
predict_time
- the new predict time.public java.lang.String latitude()
public void latitude(java.lang.String latitude)
latitude
- the new latitude.public void latitude(java.lang.Double latitude)
latitude
- the new latitude.public java.lang.String longitude()
public void longitude(java.lang.String longitude)
longitude
- the new longitude.public void longitude(java.lang.Double longitude)
longitude
- the new longitude.public java.lang.String elevation()
public void elevation(java.lang.String elevation)
elevation
- the new elevation.public void elevation(java.lang.Double elevation)
elevation
- the new elevation.public java.lang.String observation_type()
public void observation_type(java.lang.String observation_type)
observation_type
- the new observation type.public void observation_type(java.lang.Integer observation_type)
observation_type
- the new observation type.public java.lang.String orbit_number()
public void orbit_number(java.lang.String orbit_number)
orbit_number
- the new orbit number.public void orbit_number(java.lang.Integer orbit_number, java.lang.String orbit_pass)
orbit_number
- the integral component orbit number.orbit_pass
- the orbit pass component.public java.lang.String orbit_alternatives()
public void orbit_alternatives(java.lang.String orbit_alternatives)
orbit_alternatives
- the new orbit alternatives.public java.lang.String observation_duration()
public void observation_duration(java.lang.String observation_duration)
observation_duration
- the new observation duration.public void observation_duration(java.lang.Double observation_duration)
observation_duration
- the new observation duration.public java.lang.String setup_duration()
public void setup_duration(java.lang.String setup_duration)
setup_duration
- the new setup duration.public void setup_duration(java.lang.Double setup_duration)
setup_duration
- the new setup duration.public java.lang.String orbital_data_table()
A PTF record is for a HiRISE observation if and only if the first character
of the instrument_set
is "H."
public void orbital_data_table(java.lang.String orbital_data_table) throws Invalid_Argument_Exception
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."
orbital_data_table
- the new orbital data table.Invalid_Argument_Exception
- if the observation is for HiRISE and
orbital_data_table is not null or the empty string.public java.lang.String parameters_table()
A PTF record is for a HiRISE observation if and only if the first character
of the instrument_set
is "H."
public void parameters_table(java.lang.String parameters_table) throws Invalid_Argument_Exception
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_table
- the new parameters table.Invalid_Argument_Exception
- if the observation is for HiRISE and
parameters_table is not null or the empty string.public java.lang.String sequence_filename(boolean generate_filename)
If generate_filename is true and this PTF record
represents a HiRISE observation (i.e., its instrument_set()
field
starts with H), this method generates the sequence filename based
on the value of the team_database_id()
field: If the field contains
a formal HiRISE observation ID, the sequence filename is derived from it
according to the PTF SIS (d:/hir/<OBSERVAITON_ID>.mod, where
the observation ID's integer form is used). If it does not contain a formal
HiRISE observation ID, Instrument.NOT_APPLICABLE_STRING
is returned.
If generate_filename is false or if this PTF record represents another instrument's observation (the instrument set field does not start with H), then the returned filename is the original used in the construction of this PTF record. For HiRISE observations, this value may not be a correct HiRISE MRO sequence filename.
generate_filename
- If true, generate a HiRISE MRO
sequence filename based on the team database ID (for HiRISE observations
only); if false, do not generate a filename.public java.lang.String sequence_filename()
If this PTF record represents a HiRISE observation (i.e., its instrument_set()
field starts with H), this method generates the
sequence filename based on the value of the team_database_id()
field: If the field contains a formal HiRISE observation ID, the sequence
filename is derived from it according to the PTF SIS
(d:/hir/<OBSERVAITON_ID>.mod, where the observation ID's
integer form is used). If it does not contain a formal HiRISE observation
ID, Instrument.NOT_APPLICABLE_STRING
is returned.
If this PTF record represents another instrument's observation (the instrument set field does not start with H), then the returned filename is the original used in the construction of this PTF record.
sequence_filename(boolean)
,
sequence_filename(String)
public java.lang.String downlink_priority()
public void downlink_priority(java.lang.String downlink_priority)
downlink_priority
- the new downlink priority.public java.lang.String product_id()
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.
public void product_id(java.lang.String product_id) throws Invalid_Argument_Exception
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.
product_id
- the new product ID.Invalid_Argument_Exception
- if the observation is for HiRISE and
product_id is not null or the empty string.public java.lang.String instrument_spare_field_1()
public void instrument_spare_field_1(java.lang.String instrument_spare_field_1)
instrument_spare_field_1
- the new instrument spare field 1.public void instrument_spare_field_1(java.lang.Double instrument_spare_field_1)
instrument_spare_field_1
- the new instrument spare field 1.public java.lang.String instrument_spare_field_2()
public void instrument_spare_field_2(java.lang.String instrument_spare_field_2)
instrument_spare_field_2
- the new instrument spare field 2.public void instrument_spare_field_2(java.lang.Double instrument_spare_field_2)
instrument_spare_field_2
- the new instrument spare field 2.public java.lang.String instrument_spare_field_3()
public void instrument_spare_field_3(java.lang.String instrument_spare_field_3)
instrument_spare_field_3
- the new instrument spare field 3.public void instrument_spare_field_3(java.lang.Integer instrument_spare_field_3)
instrument_spare_field_3
- the new instrument spare field 3.public java.lang.String instrument_spare_field_4()
public void instrument_spare_field_4(java.lang.String instrument_spare_field_4)
instrument_spare_field_4
- the new instrument spare field 4.public java.lang.String comment()
public void comment(java.lang.String comment)
comment
- the new comment.public java.lang.String request_priority()
public void request_priority(java.lang.String request_priority)
request_priority
- the new request priority.public void request_priority(java.lang.Integer request_priority)
request_priority
- the new request priority.public java.lang.String coordinated_track_history()
public void coordinated_track_history(java.lang.String coordinated_track_history)
coordinated_track_history
- the new coordinated track history.public java.lang.String raw_data_volume()
public void raw_data_volume(java.lang.String raw_data_volume)
raw_data_volume
- the new raw data volume in megabits.public void raw_data_volume(java.lang.Double raw_data_volume)
raw_data_volume
- the new raw data volume in megabits.public java.lang.String team_database_id()
public void team_database_id(java.lang.String team_database_id)
team_database_id
- the new team database id.public java.lang.String request_category()
public void request_category(java.lang.String request_category)
request_category
- the new request category.public java.lang.String compression()
public void compression(java.lang.String compression)
compression
- the new compression.public java.lang.String pixel_scale()
public void pixel_scale(java.lang.String pixel_scale)
pixel_scale
- the new pixel scale.public java.lang.String observation_mode()
public void observation_mode(java.lang.String observation_mode)
observation_mode
- the new observation mode.public void observation_mode(Observation_Record observation_record)
observation_record
- the observation record.public java.lang.String ancillary_data()
public void ancillary_data(java.lang.String ancillary_data)
ancillary_data
- the new ancillary data.public java.lang.String lsubs()
public void lsubs(java.lang.String lsubs)
lsubs
- the new lsubs.public void lsubs(java.lang.Double lsubs)
lsubs
- the new lsubs.public java.lang.String roll_angle()
public void roll_angle(java.lang.String roll_angle)
roll_angle
- the new roll angle.public void roll_angle(java.lang.Double roll_angle)
roll_angle
- the new roll angle.public void observation_record(Observation_Record observation_record)
The sequence filename is not set; it is derived from the HiRISE team database ID (the HiRISE observation ID) when read.
observation_record
- the observation record from which PTF record
field values will be taken.public PIRL.PVL.Parameter parameter()
team database ID field
or
Instrument.UNKNOWN_STRING
if the team database ID field is empty.
The value of the sequence filename field
is
that used in the construction of this PTF record; it is not necessarily the
correct HiRISE sequence filename as derived from a formal HiRISE observation
ID.
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
The sequence filename reported by this method is the correctly derived
HiRISE filename as generated by the sequence_filename(String)
method. It is not necessarily the sequence filename used in the construction
of this record, which is not guaranteed to be correct for HiRISE
observations.
toString
in class java.lang.Object
public int hashCode()
The hash code is based on the sequence filename used in the construction of
this record, which is not necessarily the sequence filename derived via the
sequence_filename(String)
method.
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
This method compares the sequence filename used in the construction of the PTF record, not the sequence filename derived from the HiRISE team database ID.
equals
in class java.lang.Object
o
- the object to which this object is compared.public static java.util.List<java.lang.String> tokenize(java.lang.String text)
text
- the comma-separated value text.public static java.lang.String sequence_filename(java.lang.String observation_id)
Observation_ID
), this method returns Instrument.NOT_APPLICABLE_STRING
.observation_id
- the HiRISE observation ID.Instrument.NOT_APPLICABLE_STRING
.Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona