Static Public Member Functions | |
static int | c_index_to_fortran_index (int[] dim, int index) throws CodaException |
static int | isNaN (double x) |
static double | NaN () |
static int | isInf (double x) |
static int | isPlusInf (double x) |
static int | isMinInf (double x) |
static double | PlusInf () |
static double | MinInf () |
static double | time_parts_to_double (int year, int month, int day, int hour, int minute, int second, int musec) throws CodaException |
static double | time_parts_to_double_utc (int year, int month, int day, int hour, int minute, int second, int musec) throws CodaException |
static int[] | time_double_to_parts (double datetime) throws CodaException |
static int[] | time_double_to_parts_utc (double datetime) throws CodaException |
static String | time_parts_to_string (int year, int month, int day, int hour, int minute, int second, int musec, String format) throws CodaException |
static int[] | time_string_to_parts (String format, String str) throws CodaException |
static String | time_double_to_string (double datetime, String format) throws CodaException |
static String | time_double_to_string_utc (double datetime, String format) throws CodaException |
static double | time_string_to_double (String format, String str) throws CodaException |
static double | time_string_to_double_utc (String format, String str) throws CodaException |
static void | set_option_bypass_special_types (int enable) throws CodaException |
static int | get_option_bypass_special_types () |
static void | set_option_perform_boundary_checks (int enable) throws CodaException |
static int | get_option_perform_boundary_checks () |
static void | set_option_perform_conversions (int enable) throws CodaException |
static int | get_option_perform_conversions () |
static void | set_option_use_fast_size_expressions (int enable) throws CodaException |
static int | get_option_use_fast_size_expressions () |
static void | set_option_use_mmap (int enable) throws CodaException |
static int | get_option_use_mmap () |
static void | setDefinitionPath (String path) throws CodaException |
static void | setDefinitionPathConditional (String file, String searchpath, String relativeLocation) throws CodaException |
static void | init () throws CodaException |
static void | done () |
static String | version () |
CODA General class.
The CODA general class 'Coda' contains the global CODA utility functions that do not require a specific CODA data structure.
It is not possible or necessary to construct an instance of the Coda class. All methods in this class are static class methods, and can be invoked as 'Coda.methodName()'.
|
static |
Convert an index for a multidimensional array that is stored in C-style order to an index for an identical array stored in Fortran-style order.
dim | Number of dimensions of the multidimensional array. |
index | C style index. |
Fortran
style index. CodaException | If an error occurred. |
|
static |
Finalizes CODA.
|
static |
Retrieve the current setting for the special types bypass option.
0
, Bypassing of special types is disabled. 1
, Bypassing of special types is enabled.
|
static |
Retrieve the current setting for the boundary check option.
0
, Boundary checking is disabled. 1
, Boundary checking is enabled.
|
static |
Retrieve the current setting for the value/unit conversion option.
0
, Unit/value conversions are disabled. 1
, Unit/value conversions are enabled.
|
static |
Retrieve the current setting for the use of fast size expressions option.
0
, Unit/value conversions are disabled. 1
, Unit/value conversions are enabled.
|
static |
Retrieve the current setting for the use of memory mapping of files.
0
, Memory mapping of files is disabled. 1
, Memory mapping of files is enabled.
|
static |
Initializes CODA.
CodaException | If an error occurred. |
|
static |
Find out whether a double value equals inf (either positive or negative infinity).
x | A double value. |
1
, The double value equals inf. 0
, The double value does not equal inf.
|
static |
Find out whether a double value equals -inf (negative infinity).
x | A double value. |
1
, The double value equals -inf. 0
, The double value does not equal -inf.
|
static |
Find out whether a double value equals NaN (Not a Number).
x | A double value. |
1
, The double value equals NaN. 0
, The double value does not equal NaN.
|
static |
Find out whether a double value equals +inf (positive infinity).
x | A double value. |
1
, The double value equals +inf. 0
, The double value does not equal +inf.
|
static |
Retrieve a double value that respresents -inf (negative infinity).
|
static |
Retrieve a double value that respresents NaN (Not a Number).
|
static |
Retrieve a double value that respresents +inf (positive infinity).
|
static |
Enable/Disable the use of special types.
enable |
|
CodaException | If an error occurred. |
|
static |
Enable/Disable boundary checking.
enable |
|
CodaException | If an error occurred. |
|
static |
Enable/Disable unit/value conversions.
enable |
|
CodaException | If an error occurred. |
|
static |
Enable/Disable the use of fast size expressions.
enable |
|
CodaException | If an error occurred. |
|
static |
Enable/Disable the use of memory mapping of files.
enable |
|
CodaException | If an error occurred. |
|
static |
Set the searchpath for CODA product definition files.
path | Search path for .codadef files |
CodaException | If an error occurred. |
|
static |
Set the location of CODA product definition file(s) based on the location of another file.
file | Filename of the file to search for |
searchpath | Search path where to look for the file |
relativeLocation | Filepath relative to the directory from searchpath where file was found that should be used to determine the CODA definition path |
CodaException | If an error occurred. |
|
static |
Retrieve the decomposed date corresponding with the given amount of seconds since Jan 1st 2000.
datetime | Floating point value representing the number of seconds since January 1st, 2000 00:00:00.000000. |
[0] year - The year.
[1] month - The month of the year (1 - 12)
[2] day - The day of the month (1 - 31)
[3] hour - The hour of the day (0 - 23)
[4] minute - The minute of the hour (0 - 59)
[5] second - The second of the minute (0 - 59)
[6] musec - The microseconds of the second (0 - 999999) CodaException | If an error occurred. |
|
static |
Retrieve the decomposed UTC date corresponding with the given amount of TAI seconds since Jan 1st 2000. This function assumes the input to by the number of seconds since 2000-01-01 in the TAI system. The returned date/time components will be the corresponding UTC datetime (using proper leap second handling for the TAI to UTC conversion). For example: -88361290 will be 1972-01-01 00:00:00 UTC 0 will be 1999-31-12 23:59:28 UTC 284083232 will be 2008-12-31 23:59:59 UTC 284083233 will be 2008-12-31 23:59:60 UTC 284083234 will be 2009-01-01 00:00:00 UTC
datetime | Floating point value representing the number of seconds since January 1st, 2000 00:00:00.000000. |
[0] year - The year.
[1] month - The month of the year (1 - 12)
[2] day - The day of the month (1 - 31)
[3] hour - The hour of the day (0 - 23)
[4] minute - The minute of the hour (0 - 59)
[5] second - The second of the minute (0 - 59)
[6] musec - The microseconds of the second (0 - 999999) CodaException | If an error occurred. |
|
static |
Convert a floating point time value to a string using a specified format. The string will be formatted using the format that is provided as second parameter. The time string will be stored in the str parameter. This parameter should be allocated by the user and should be long enough to hold the formatted time string and a 0 termination character.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
datetime | Floating point value representing the number of seconds since January 1st, 2000 00:00:00.000000. |
format | Date/time format to use for the string representation of the datetime value. |
CodaException | If an error occurred. |
|
static |
Convert a floating point TAI time value to a UTC string. The string will be formatted using the format that is provided as second parameter. The time string will be stored in the str parameter. This parameter should be allocated by the user and should be long enough to hold the formatted time string and a 0 termination character.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
This function performs proper leap second correction in the conversion from TAI to UTC (see also time_double_to_parts_utc()).
datetime | Floating point value representing the number of seconds since January 1st, 2000 00:00:00.000000. |
format | Date/time format to use for the string representation of the datetime value. |
CodaException | If an error occurred. |
|
static |
Retrieve the number of seconds since Jan 1st 2000 for a certain date and time.
year | The year. |
month | The month of the year (1 - 12). |
day | The day of the month (1 - 31). |
hour | The hour of the day (0 - 23). |
minute | The minute of the hour (0 - 59). |
second | The second of the minute (0 - 59). |
musec | The microseconds of the second (0 - 999999). |
CodaException | If an error occurred. |
|
static |
Retrieve the number of TAI seconds since Jan 1st 2000 for a certain UTC date and time using leap second correction. This function assumes the input to be an UTC datetime. The returned value will be the seconds since 2000-01-01 in the TAI time system (using proper leap second handling for the UTC to TAI conversion). For example: 1972-01-01 00:00:00 UTC will be -883612790 2000-01-01 00:00:00 UTC will be 32 2008-12-31 23:59:59 UTC will be 284083232 2008-12-31 23:59:60 UTC will be 284083233 2009-01-01 00:00:00 UTC will be 284083234
year | The year. |
month | The month of the year (1 - 12). |
day | The day of the month (1 - 31). |
hour | The hour of the day (0 - 23). |
minute | The minute of the hour (0 - 59). |
second | The second of the minute (0 - 59). |
musec | The microseconds of the second (0 - 999999). |
CodaException | If an error occurred. |
|
static |
Create a string representation for a specific data and time. The string will be formatted using the format that is provided as first parameter. The time string will be stored in the str parameter. This parameter should be allocated by the user and should be long enough to hold the formatted time string and a 0 termination character.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
year | The year. |
month | The month of the year (1 - 12). |
day | The day of the month (1 - 31). |
hour | The hour of the day (0 - 23). |
minute | The minute of the hour (0 - 59). |
second | The second of the minute (0 - 59). |
musec | The microseconds of the second (0 - 999999). |
format | Date/time format to use for the string representation of the datetime value. |
CodaException | If an error occurred. |
|
static |
Convert a time string to a floating point time value. The string will be parsed using the format that is provided as first parameter. This can be a '|' separated list of formats that will be tried in sequence until one succeeds.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
format | Date/time format to use for the string representation of the datetime value. |
str | String containing the time in one of the supported formats. |
CodaException | If an error occurred. |
|
static |
Convert a UTC time string to a TAI floating point time value. The string will be parsed using the format that is provided as first parameter. This can be a '|' separated list of formats that will be tried in sequence until one succeeds.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
This function performs proper leap second correction in the conversion from UTC to TAI (see also time_parts_to_double_utc()).
format | Date/time format to use for the string representation of the datetime value. |
str | String containing the time in one of the supported formats. |
CodaException | If an error occurred. |
|
static |
Convert a time string to a date and time using a specified format. The string will be parsed using the format that is provided as first parameter. This can be a '|' separated list of formats that will be tried in sequence until one succeeds.
The specification for the time format parameter is the same as the date/time format patterns in coda expressions.
format | Date/time format to use for the string representation of the datetime value. |
str | String representation of the floating point time value. |
[0] year - The year.
[1] month - The month of the year (1 - 12)
[2] day - The day of the month (1 - 31)
[3] hour - The hour of the day (0 - 23)
[4] minute - The minute of the hour (0 - 59)
[5] second - The second of the minute (0 - 59)
[6] musec - The microseconds of the second (0 - 999999) CodaException | If an error occurred. |
|
static |
Current version of CODA as a string.