agi.foundation.navigation.datareaders

(agi.foundation.navigation-2024r3.jar)

Class RinexMeteorological

java.lang.Object

agi.foundation.compatibility.BaseCollection<RinexMeteorologicalRecord>

agi.foundation.navigation.datareaders.RinexMeteorological

All Implemented Interfaces:

Iterable<RinexMeteorologicalRecord>, Collection<RinexMeteorologicalRecord>, List<RinexMeteorologicalRecord>

public final class RinexMeteorological
extends BaseCollection<RinexMeteorologicalRecord>

A RINEX Meteorological file describing weather conditions at the receiving antenna. This class represents a RINEX Meteorological file, version 2.0, 2.1 and 2.11. Other versions are not supported.

Reading compressed RINEX files is not currently supported.

Method Summary

Modifier and Type	Method and Description
String	getDate() Gets the date of file creation.
Evaluator<RinexMeteorologicalRecord>	getEvaluator() Gets an evaluator that can be used to find meteorological data over time.
Evaluator<RinexMeteorologicalRecord>	getEvaluator(EvaluatorGroup group) Gets an evaluator that can be used to find meteorological data over time.
ArrayList<MeteorologicalMeasurement>	getMeasurementTypes() Gets a list of the meteorological data types in the file.
int	getNumberOfMeasurementTypes() Gets the number of meteorological data types in the file.
String	getProgram() Gets the program that created the file.
String	getRunBy() Gets the agency that created the file.
static RinexMeteorological	readFrom(BufferedReader reader) Reads a RINEX Meteorological file from the specified stream.
static RinexMeteorological	readFrom(String fileName) Reads a RINEX Meteorological file from the specified filename.

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, clearItems, contains, containsAll, get, getItems, indexOf, insertItem, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeItem, retainAll, set, setItem, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

readFrom

@Nonnull
public static RinexMeteorological readFrom(@Nonnull
                                                     String fileName)

Reads a RINEX Meteorological file from the specified filename.

Parameters:

fileName - The name of the file from which to read the meteorological data.

Returns:

The meteorological data read from the file.

Throws:

ArgumentNullException - Thrown when fileName is null.

InvalidDataException - Thrown when the Rinex Meteorological File has an invalid format.

readFrom

@Nonnull
public static RinexMeteorological readFrom(@Nonnull
                                                     BufferedReader reader)

Reads a RINEX Meteorological file from the specified stream.

Parameters:

reader - The stream from which to read the meteorological data.

Returns:

The meteorological data read from the stream.

Throws:

ArgumentNullException - Thrown when reader is null.

InvalidDataException - Thrown when the Rinex Meteorological File has an invalid format.

getEvaluator

@Nonnull
public final Evaluator<RinexMeteorologicalRecord> getEvaluator()

Gets an evaluator that can be used to find meteorological data over time.

Returns:

An evaluator to find the meteorological data over time.

getEvaluator

@Nonnull
public final Evaluator<RinexMeteorologicalRecord> getEvaluator(@Nonnull
                                                                         EvaluatorGroup group)

Gets an evaluator that can be used to find meteorological data over time.

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the meteorological data over time.

getProgram

@Nonnull
public final String getProgram()

Gets the program that created the file.

getRunBy

@Nonnull
public final String getRunBy()

Gets the agency that created the file.

getDate

@Nonnull
public final String getDate()

Gets the date of file creation.

getNumberOfMeasurementTypes

public final int getNumberOfMeasurementTypes()

Gets the number of meteorological data types in the file.

getMeasurementTypes

@Nonnull
public final ArrayList<MeteorologicalMeasurement> getMeasurementTypes()

Gets a list of the meteorological data types in the file.