Package getdata-devel

Headers required when building programs against getdata

http://getdata.sourceforge.net/

Headers required when building a program against the GetData library.
Includes C++ and FORTRAN (77 & 95) bindings.

Library Functions (Section 3)
gd_add
The gd_add() function adds the field described by entry to the dirfile specified by dirfile. The gd_madd() function behaves similarly, but adds the field as a...
gd_add_alias
The gd_add_alias() function adds the alias named alias_name pointing to target_code to the fragment indexed by fragment_index in the dirfile specified by...
gd_add_bit
These functions provide alternatives to using the gd_add(3) or gd_add_spec(3) functions to add a new field of the indicated type to the dirfile specified by...
gd_add_spec
The gd_add_spec() function adds the field described by the field specification line in line to the dirfile specified by dirfile. The gd_madd_spec() function...
gd_aliases
The gd_aliases() function queries a dirfile(5) database specified by dirfile and returns a read-only list of aliases of the field specified by field_code. The...
gd_alias_target
The gd_alias_target() function queries a dirfile(5) database specified by dirfile and returns the target field code of the alias specified by alias_name. The...
gd_alter_affixes
The gd_alter_affixes() function sets the field prefix and suffix of fields defined in the format specification fragment given by fragment_index to prefix and...
gd_alter_bit
These functions provide alternatives to using the gd_alter_entry(3) function to modify a field of the indicated type in the dirfile specified by dirfile. In all...
gd_alter_encoding
The gd_alter_encoding() function sets the binary encoding of the format specification fragment given by fragment_index to the encoding specified by encoding in...
gd_alter_endianness
The gd_alter_endianness() function sets the byte sex of the format specification fragment given by fragment_index to byte_sex in the dirfile(5) database...
gd_alter_entry
The gd_alter_entry() function modifies the field specified by field_code in the dirfile specified by dirfile to correspond to the new parameters specified by...
gd_alter_frameoffset
The gd_alter_frameoffset() function sets the frame offset of the format specification fragment given by fragment_index to offset in the dirfile(5) database...
gd_alter_protection
The gd_alter_protection() function sets the advisory protection level of the format specification fragment given by fragment_index to protection_level in the...
gd_alter_spec
The gd_alter_spec() function modifies the field described by the field specification line in line to the dirfile specified by dirfile. The gd_malter_spec()...
gd_array_len
The gd_array_len() function queries a dirfile(5) database specified by dirfile and returns the number of length of the CARRAY, CONST, STRING, or SARRAY field...
gd_bof
The gd_bof() function queries a dirfile(5) database specified by dirfile and returns the sample number of the beginning-of-field marker for the vector field...
gd_bof64
This version of gd_bof(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one defines...
gd_carrays
The gd_carrays() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CARRAY fields defined in the...
gd_cbopen
The gd_cbopen() function opens or creates the dirfile specified by dirfilename, returning a DIRFILE object associated with it. Opening a dirfile will cause the...
gd_close
The gd_close() function first calls gd_flush(3) (with field_code set to NULL) to flush all metadata changes to disk and to close all file handles associated...
gd_constants
The gd_constants() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CONST fields defined in the...
gd_delete
The gd_delete() function attempts to delete the field or alias specified by field_code in the dirfile specified by dirfile. The field_code should not contain a...
gd_desync
The gd_desync() function reports whether the metadata of the loaded dirfile has become desynchronised from the format specification fragments on disk, due to a...
gd_dirfilename
The gd_dirfilename() function queries a dirfile(5) database specified by dirfile and returns its name. The name of a dirfile is an absolute pathname which...
gd_dirfile_standards
The gd_dirfile_standards() function updates the current Standards Version for the open dirfile dirfile to the value specified by version, if possible, and then...
gd_encoding
The gd_encoding() function queries a dirfile(5) database specified by dirfile and returns the binary encoding for the fragment indexed by fragment_index. The...
gd_encoding_support
The gd_encoding_support() function reports whether the Dirfile encoding specified by encoding is supported by the GetData library. The encoding argument should...
gd_endianness
The gd_endianness() function queries a dirfile(5) database specified by dirfile and returns the byte sex for the fragment indexed by fragment_index. The byte...
gd_entry
The gd_entry() function queries a dirfile(5) database specified by dirfile and returns the metadata associated with the field specified by field_code. If...
gd_entry_list
The gd_entry_list() function queries a dirfile(5) database specified by dirfile and returns a list of names of field entries satisfying the supplied criteria...
gd_entry_type
The gd_entry_type() function queries a dirfile(5) database specified by dirfile and returns the field type of the field specified by field_code. If field_code...
gd_eof
The gd_eof() function queries a dirfile(5) database specified by dirfile and returns the sample number of the end-of-field marker for the vector field given by...
gd_eof64
This version of gd_eof(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one defines...
gd_error
The gd_error() function returns the numeric dirfile error associated with the dirfile dirfile which is set by many GetData library functions. A textual...
gd_error_count
The first time gd_error_count() is called with the DIRFILE object dirfile, it returns the number of errors encountered by the GetData library while operating on...
gd_error_string
The gd_error_string() function returns a string describing the last dirfile error encountered while operating on dirfile. If buffer is not NULL, the string is...
gd_flags
The gd_flags() function modifies the operational flags of the dirfile(5) database specified by dirfile, and returns the new value of the flags register. The...
gd_flush
The gd_sync() function flushes all pending writes to disk of raw data files associated with field_code, or its input(s), in the dirfile specified by dirfile. If...
gd_fragment_affixes
The gd_fragment_affixes() function queries a dirfile(5) database specified by dirfile and returns the field affixes for the fragment indexed by fragment_index...
gd_fragment_index
The gd_fragment_index() function queries a dirfile(5) database specified by dirfile and returns the index number of the fragment defining the field or alias...
gd_fragmentname
The gd_fragmentname() function queries a dirfile(5) database specified by dirfile and returns the filename of the format specification fragment indexed by the...
gd_framenum_subset
The gd_framenum_subset() function queries a dirfile(5) database specified by dirfile and returns the fractional frame number at which the field specified by...
gd_framenum_subset64
This version of gd_framenum_subset(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if...
gd_frameoffset
The gd_frameoffset() function queries a dirfile(5) database specified by dirfile and returns the frame offset (see dirfile-format(5)) for the fragment indexed...
gd_frameoffset64
These versions of gd_frameoffset(3) and gd_alter_frameoffset(3) use a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t...
gd_free_entry_strings
The gd_free_entry_strings() function frees the character strings found in the gd_entry_t object entry which were previously allocated by a call to gd_entry(3)...
gd_get_carray_slice
The gd_get_carray_slice() function queries a dirfile(5) database specified by dirfile for the CONST or CARRAY scalar array field_code, which may contain a...
gd_getdata
The gd_getdata() function queries a dirfile(5) database specified by dirfile for the field field_code. It fetches num_frames frames plus num_samples samples...
gd_getdata64
This version of gd_getdata(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one...
gd_get_string
The gd_get_string() function queries a dirfile(5) database specified by dirfile for the string scalar field_code, which should not contain a representation...
gd_hidden
The gd_hidden() function queries a dirfile(5) database specified by dirfile and indicates whether the field or alias called entry_name is hidden or not. This...
gd_hide
The gd_hide() function hides the field or alias called entry_name in the dirfile(5) database specified by dirfile and indicates whether the field or alias...
gd_include_affix
The gd_include_affix() function adds the format specification fragment given by the path include_file to the specified dirfile, possibly creating the fragment...
gd_invalid_dirfile
The gd_invalid_dirfile() returns a pointer to a newly allocated, invalid DIRFILE object. Like any other DIRFILE object, the invalid DIRFILE object should be...
gd_linterp_tablename
The gd_linterp_tablename() function retrieves the pathname of the look-up table (LUT) used by the LINTERP field specified by field_code in the dirfile specified...
gd_madd_bit
These functions add a new metafield of the indicated type under the parent field given by parent in the dirfile specified by dirfile. In all of these calls...
gd_mcarrays
The gd_mcarrays() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CARRAY metafields for the...
gd_metaflush
The gd_metaflush() function flushes all pending metadata changes in the dirfile specified by dirfile to disk. This is accomplished by re-writing the format...
gd_move
The gd_move() function transfers the field or alias specified by field_code, which should not have a representation suffix, defined in the dirfile specified by...
gd_mplex_lookback
The gd_mplex_lookback() function controls how far GetData searches backwards for the initial value of a field when reading a MPLEX field from the dirfile(5)...
gd_mstrings
The gd_mstrings() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all STRING type metafields for the...
gd_naliases
The gd_naliases() function queries a dirfile(5) database specified by dirfile and returns the number of aliases of the field specified by field_code. The...
gd_native_type
The gd_native_type() function queries a dirfile(5) database specified by dirfile and returns the native data type of the field field_code, which may contain a...
gd_nentries
The gd_nentries() function queries a dirfile(5) database specified by dirfile and returns a count of metadata entries satisfying the supplied criteria. If...
gd_nfragments
The gd_nfragments() function queries a dirfile(5) database specified by dirfile and returns the total number of parsed format specification fragments in the...
gd_nframes
The gd_nframes() function queries a dirfile(5) database specified by dirfile and returns the number of frames in the database. Since different fields may have...
gd_nframes64
This version of gd_nframes(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one...
gd_parent_fragment
The gd_parent_fragment() function queries a dirfile(5) database specified by dirfile and returns the index of the fragment which contains the INCLUDE directive...
gd_parser_callback
The gd_parser_callback() function updates the syntax error callback function of the DIRFILE object dirfile to be sehandler, and the caller supplied extra...
gd_protection
The gd_protection() function queries a dirfile(5) database specified by dirfile and returns the advisory protection level for the fragment indexed by...
gd_put_carray_slice
The gd_put_carray_slice() function writes data to a dirfile(5) database specified by dirfile into the CARRAY scalar array field_code. The data in the field is...
gd_putdata
The gd_putdata() function writes data to a dirfile(5) database specified by dirfile for the field field_code, which may not contain a representation suffix. It...
gd_putdata64
This version of gd_putdata(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one...
gd_put_string
The gd_put_string() function queries a dirfile(5) database specified by dirfile and sets the STRING field_code , which should not contain a representation...
gd_raw_filename
The gd_raw_filename() function reports the pathname of the file backing the RAW field specified by field_code in the dirfile specified by dirfile. If field_code...
gd_reference
The gd_reference() function sets or retrieves the reference field (see dirfile(5)) associated with the dirfile specified by dirfile. If the field_code argument...
gd_rename
The gd_rename() function changes the name of the field or alias specified by old_code, which should not contain a representation suffix, defined in the dirfile...
gd_rewrite_fragment
The gd_rewrite_fragment() writes the format specification fragment specified by fragment to disk, regardless of whether it has changed or not, overwriting the...
gd_seek
The gd_seek() function changes the position of the I/O pointer associated with the field field_code in the dirfile(5) database specified by dirfile. In normal...
gd_seek64
This version of gd_seek(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one defines...
GD_SIZE
The GD_SIZE() preprocessor macro returns the size (in bytes) of a single sample of data of the type specified by type, which should be one of the...
gd_spf
The gd_spf() function queries a dirfile(5) database specified by dirfile and returns the number of samples per frame for the field field_code. If field_code...
gd_strings
The gd_strings() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all STRING type fields defined in the...
gd_strtok
The gd_strtok() function parses a string into a series of tokens according to the rules of the Dirfile metadata syntax (see dirfile-format(5)). The first time...
gd_tell
The gd_tell() function reports the current position of the I/O pointer of the field field_code in the dirfile(5) database specified by dirfile. Only RAW fields...
gd_tell64
This version of gd_tell(3) uses a 64-bit offset type (gd_off64_t), where one is available, regardless of the size of off_t. It is only available if one defines...
gd_uninclude
The gd_uninclude() removes the format specification fragment indexed by fragment_index from the specified dirfile, as well as any fragments the indicated...
gd_validate
The gd_validate() function queries a dirfile(5) database specified by dirfile and checks whether field_code, which may contain a representation suffix...
gd_verbose_prefix
The gd_verbose_prefix() sets the prefix printed before error messages output by the GetData library for the dirfile(5) database specified by dirfile. If prefix...