|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object HiRISE.HiPlan.IO.PTF_Record
PTF_Record
.
public class PTF_Record
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.
Field Summary | |
---|---|
static String |
ID
Deprecated. Class identification name with source code version and date. |
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 |
---|
public static final String ID
Constructor Detail |
---|
public PTF_Record()
public PTF_Record(String ptf_record_text) throws Invalid_Argument_Exception
Invalid_Argument_Exception
is thrown.
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.Method Detail |
---|
public String instrument_set()
public void instrument_set(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 String predict_time()
public void predict_time(String predict_time)
predict_time
- the new predict time.public String latitude()
public void latitude(String latitude)
latitude
- the new latitude.public String longitude()
public void longitude(String longitude)
longitude
- the new longitude.public String elevation()
public void elevation(String elevation)
elevation
- the new elevation.public String observation_type()
public void observation_type(String observation_type)
observation_type
- the new observation type.public String orbit_number()
public void orbit_number(String orbit_number)
orbit_number
- the new orbit number.public String orbit_alternatives()
public void orbit_alternatives(String orbit_alternatives)
orbit_alternatives
- the new orbit alternatives.public String observation_duration()
public void observation_duration(String observation_duration)
observation_duration
- the new observation duration.public String setup_duration()
public void setup_duration(String setup_duration)
setup_duration
- the new setup duration.public 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(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 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(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 String sequence_filename()
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).
public String downlink_priority()
public void downlink_priority(String downlink_priority)
downlink_priority
- the new downlink priority.public 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(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 String instrument_spare_field_1()
public void instrument_spare_field_1(String instrument_spare_field_1)
instrument_spare_field_1
- the new instrument spare field 1.public String instrument_spare_field_2()
public void instrument_spare_field_2(String instrument_spare_field_2)
instrument_spare_field_2
- the new instrument spare field 2.public String instrument_spare_field_3()
public void instrument_spare_field_3(String instrument_spare_field_3)
instrument_spare_field_3
- the new instrument spare field 3.public String instrument_spare_field_4()
public void instrument_spare_field_4(String instrument_spare_field_4)
instrument_spare_field_4
- the new instrument spare field 4.public String comment()
public void comment(String comment)
comment
- the new comment.public String request_priority()
public void request_priority(String request_priority)
request_priority
- the new request priority.public String coordinated_track_history()
public void coordinated_track_history(String coordinated_track_history)
coordinated_track_history
- the new coordinated track history.public String raw_data_volume()
public void raw_data_volume(String raw_data_volume)
raw_data_volume
- the new raw data volume in megabits.public String team_database_id()
public void team_database_id(String team_database_id)
team_database_id
- the new team database id.public String request_category()
public void request_category(String request_category)
request_category
- the new request category.public String compression()
public void compression(String compression)
compression
- the new compression.public String pixel_scale()
public void pixel_scale(String pixel_scale)
pixel_scale
- the new pixel scale.public String observation_mode()
public void observation_mode(String observation_mode)
observation_mode
- the new observation mode.public String ancillary_data()
public void ancillary_data(String ancillary_data)
ancillary_data
- the new ancillary data.public String lsubs()
public void lsubs(String lsubs)
lsubs
- the new lsubs.public String roll_angle()
public void roll_angle(String roll_angle)
roll_angle
- the new roll angle.public Object clone()
clone
in class Object
public String toString()
toString
in class Object
public String pvl_text(int indent_level)
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.
indent_level
- the number of tabs to use for the top level indent.
public String pvl_text()
pvl_text(int)
public static Vector tokenize(String text)
text
- the comma-separated value text.
public static int field_index(String field)
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.
field
- the putative field name.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |