Typedefs | |
| typedef _cpl_plist_ | cpl_plist |
| The opaque property list data type. More... | |
Functions | |
| cpl_plist * | cpl_plist_new (void) |
| Create an empty property list. More... | |
| cpl_plist * | cpl_plist_duplicate (const cpl_plist *plist) |
| Create a copy of the given property list. More... | |
| void | cpl_plist_delete (cpl_plist *plist) |
| Destroy a property list. More... | |
| long | cpl_plist_get_size (const cpl_plist *plist) |
| Get the current size of a property list. More... | |
| long | cpl_plist_max_size (const cpl_plist *plist) |
| Get the maximum number of property list entries possible. More... | |
| int | cpl_plist_is_empty (const cpl_plist *plist) |
| Check whether a property list is empty. More... | |
| cpl_type | cpl_plist_get_type (const cpl_plist *plist, const char *name) |
| Get the the type of a property list entry. More... | |
| int | cpl_plist_contains (const cpl_plist *plist, const char *name) |
| Check whether a property is present in a property list. More... | |
| int | cpl_plist_set_comment (cpl_plist *plist, const char *name, const char *comment) |
| Modify the comment field of the given property list entry. More... | |
| int | cpl_plist_set_char (cpl_plist *plist, const char *name, char value) |
| Set the value of the given character property list entry. More... | |
| int | cpl_plist_set_bool (cpl_plist *plist, const char *name, int value) |
| Set the value of the given boolean property list entry. More... | |
| int | cpl_plist_set_int (cpl_plist *plist, const char *name, int value) |
| Set the value of the given integer property list entry. More... | |
| int | cpl_plist_set_long (cpl_plist *plist, const char *name, long value) |
| Set the value of the given long property list entry. More... | |
| int | cpl_plist_set_float (cpl_plist *plist, const char *name, float value) |
| Set the value of the given float property list entry. More... | |
| int | cpl_plist_set_double (cpl_plist *plist, const char *name, double value) |
| Set the value of the given double property list entry. More... | |
| int | cpl_plist_set_string (cpl_plist *plist, const char *name, const char *value) |
| Set the value of the given string property list entry. More... | |
| cpl_property * | cpl_plist_get_element (cpl_plist *plist, long index) |
| Access property list elements by index. More... | |
| const char * | cpl_plist_get_comment (const cpl_plist *plist, const char *name) |
| Get the comment of the given property list entry. More... | |
| char | cpl_plist_get_char (const cpl_plist *plist, const char *name) |
| Get the character value of the given property list entry. More... | |
| int | cpl_plist_get_bool (const cpl_plist *plist, const char *name) |
| Get the boolean value of the given property list entry. More... | |
| int | cpl_plist_get_int (const cpl_plist *plist, const char *name) |
| Get the integer value of the given property list entry. More... | |
| long | cpl_plist_get_long (const cpl_plist *plist, const char *name) |
| Get the long value of the given property list entry. More... | |
| float | cpl_plist_get_float (const cpl_plist *plist, const char *name) |
| Get the float value of the given property list entry. More... | |
| double | cpl_plist_get_double (const cpl_plist *plist, const char *name) |
| Get the double value of the given property list entry. More... | |
| const char * | cpl_plist_get_string (const cpl_plist *plist, const char *name) |
| Get the string value of the given property list entry. More... | |
| int | cpl_plist_insert_char (cpl_plist *plist, const char *here, const char *name, char value) |
| Insert a character value into a property list at the given position. More... | |
| int | cpl_plist_insert_bool (cpl_plist *plist, const char *here, const char *name, int value) |
| Insert a boolean value into a property list at the given position. More... | |
| int | cpl_plist_insert_int (cpl_plist *plist, const char *here, const char *name, int value) |
| Insert a integer value into a property list at the given position. More... | |
| int | cpl_plist_insert_long (cpl_plist *plist, const char *here, const char *name, long value) |
| Insert a long value into a property list at the given position. More... | |
| int | cpl_plist_insert_float (cpl_plist *plist, const char *here, const char *name, float value) |
| Insert a float value into a property list at the given position. More... | |
| int | cpl_plist_insert_double (cpl_plist *plist, const char *here, const char *name, double value) |
| Insert a double value into a property list at the given position. More... | |
| int | cpl_plist_insert_string (cpl_plist *plist, const char *here, const char *name, const char *value) |
| Insert a string value into a property list at the given position. More... | |
| int | cpl_plist_insert_after_char (cpl_plist *plist, const char *after, const char *name, char value) |
| Insert a character value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_bool (cpl_plist *plist, const char *after, const char *name, int value) |
| Insert a boolean value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_int (cpl_plist *plist, const char *after, const char *name, int value) |
| Insert a integer value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_long (cpl_plist *plist, const char *after, const char *name, long value) |
| Insert a long value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_float (cpl_plist *plist, const char *after, const char *name, float value) |
| Insert a float value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_double (cpl_plist *plist, const char *after, const char *name, double value) |
| Insert a double value into a property list after the given position. More... | |
| int | cpl_plist_insert_after_string (cpl_plist *plist, const char *after, const char *name, const char *value) |
| Insert a string value into a property list after the given position. More... | |
| int | cpl_plist_prepend_char (cpl_plist *plist, const char *name, char value) |
| Prepend a character value to a property list. More... | |
| int | cpl_plist_prepend_bool (cpl_plist *plist, const char *name, int value) |
| Prepend a boolean value to a property list. More... | |
| int | cpl_plist_prepend_int (cpl_plist *plist, const char *name, int value) |
| Prepend a integer value to a property list. More... | |
| int | cpl_plist_prepend_long (cpl_plist *plist, const char *name, long value) |
| Prepend a long value to a property list. More... | |
| int | cpl_plist_prepend_float (cpl_plist *plist, const char *name, float value) |
| Prepend a float value to a property list. More... | |
| int | cpl_plist_prepend_double (cpl_plist *plist, const char *name, double value) |
| Prepend a double value to a property list. More... | |
| int | cpl_plist_prepend_string (cpl_plist *plist, const char *name, const char *value) |
| Prepend a string value to a property list. More... | |
| int | cpl_plist_append_char (cpl_plist *plist, const char *name, char value) |
| Append a character value to a property list. More... | |
| int | cpl_plist_append_bool (cpl_plist *plist, const char *name, int value) |
| Append a boolean value to a property list. More... | |
| int | cpl_plist_append_int (cpl_plist *plist, const char *name, int value) |
| Append an integer value to a property list. More... | |
| int | cpl_plist_append_long (cpl_plist *plist, const char *name, long value) |
| Append a long value to a property list. More... | |
| int | cpl_plist_append_float (cpl_plist *plist, const char *name, float value) |
| Append a float value to a property list. More... | |
| int | cpl_plist_append_double (cpl_plist *plist, const char *name, double value) |
| Append a double value to a property list. More... | |
| int | cpl_plist_append_string (cpl_plist *plist, const char *name, const char *value) |
| Append a string value to a property list. More... | |
| int | cpl_plist_erase (cpl_plist *plist, const char *name) |
| Erase the given property from a property list. More... | |
| int | cpl_plist_erase_regexp (cpl_plist *plist, const char *regexp) |
| Erase all properties with name matching a given regular expression. More... | |
| void | cpl_plist_clear (cpl_plist *plist) |
| Remove all properties from a property list. More... | |
| int | cpl_plist_load (cpl_plist *plist, const char *name, int index) |
| Create a property list from a file. More... | |
| qfits_header * | cpl_plist_to_fits (const cpl_plist *plist) |
| Convert a property list to a FITS header. More... | |
| cpl_plist * | cpl_plist_from_fits (const qfits_header *header) |
| Create a property list from a FITS header. More... | |
#include <cpl_plist.h>
|
|
The opaque property list data type.
|
|
||||||||||||||||
|
Append a boolean value to a property list.
|
|
||||||||||||||||
|
Append a character value to a property list.
|
|
||||||||||||||||
|
Append a double value to a property list.
|
|
||||||||||||||||
|
Append a float value to a property list.
|
|
||||||||||||||||
|
Append an integer value to a property list.
|
|
||||||||||||||||
|
Append a long value to a property list.
|
|
||||||||||||||||
|
Append a string value to a property list.
|
|
|
Remove all properties from a property list.
|
|
||||||||||||
|
Check whether a property is present in a property list.
|
|
|
Destroy a property list.
|
|
|
Create a copy of the given property list.
|
|
||||||||||||
|
Erase the given property from a property list.
|
|
||||||||||||
|
Erase all properties with name matching a given regular expression.
|
|
|
Create a property list from a FITS header.
The FITS header header is left untouched, i.e. the conversion is non-destructive. The special FITS keyword END indicating the end of a FITS header is not transformed into a property, but simply ignored.
In case of an error, an appropriate error code is set. If a FITS header card cannot be parsed the error code is set to |
|
||||||||||||
|
Get the boolean value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Get the character value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Get the comment of the given property list entry.
NULL.
Additionally, the function sets the error |
|
||||||||||||
|
Get the double value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Access property list elements by index.
NULL. |
|
||||||||||||
|
Get the float value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Get the integer value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Get the long value of the given property list entry.
Additionally, the function sets the error |
|
|
Get the current size of a property list.
|
|
||||||||||||
|
Get the string value of the given property list entry.
Additionally, the function sets the error |
|
||||||||||||
|
Get the the type of a property list entry.
|
|
||||||||||||||||||||
|
Insert a boolean value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a character value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a double value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a float value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a integer value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a long value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a string value into a property list after the given position.
|
|
||||||||||||||||||||
|
Insert a boolean value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a character value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a double value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a float value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a integer value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a long value into a property list at the given position.
|
|
||||||||||||||||||||
|
Insert a string value into a property list at the given position.
|
|
|
Check whether a property list is empty.
|
|
||||||||||||||||
|
Create a property list from a file.
The function returns 1 if the file name cannot be accessed, has an unknown file format or does not contain any properties. The provided property list plist must be empty. |
|
|
Get the maximum number of property list entries possible.
|
|
|
Create an empty property list.
|
|
||||||||||||||||
|
Prepend a boolean value to a property list.
|
|
||||||||||||||||
|
Prepend a character value to a property list.
|
|
||||||||||||||||
|
Prepend a double value to a property list.
|
|
||||||||||||||||
|
Prepend a float value to a property list.
|
|
||||||||||||||||
|
Prepend a integer value to a property list.
|
|
||||||||||||||||
|
Prepend a long value to a property list.
|
|
||||||||||||||||
|
Prepend a string value to a property list.
|
|
||||||||||||||||
|
Set the value of the given boolean property list entry.
|
|
||||||||||||||||
|
Set the value of the given character property list entry.
|
|
||||||||||||||||
|
Modify the comment field of the given property list entry.
NULL. In this case an already existing comment is deleted. |
|
||||||||||||||||
|
Set the value of the given double property list entry.
|
|
||||||||||||||||
|
Set the value of the given float property list entry.
|
|
||||||||||||||||
|
Set the value of the given integer property list entry.
|
|
||||||||||||||||
|
Set the value of the given long property list entry.
|
|
||||||||||||||||
|
Set the value of the given string property list entry.
|
|
|
Convert a property list to a FITS header.
If a property cannot be converted into a valid FITS keyword the function fails. |
1.2.14 written by Dimitri van Heesch,
© 1997-2002