Typedefs | |
typedef _cpl_propertylist_ | cpl_propertylist |
The opaque property list data type. | |
Functions | |
cpl_propertylist * | cpl_propertylist_new (void) |
Create an empty property list. | |
cpl_propertylist * | cpl_propertylist_duplicate (const cpl_propertylist *self) |
Create a copy of the given property list. | |
void | cpl_propertylist_delete (cpl_propertylist *self) |
Destroy a property list. | |
long | cpl_propertylist_get_size (const cpl_propertylist *self) |
Get the current size of a property list. | |
int | cpl_propertylist_is_empty (const cpl_propertylist *self) |
Check whether a property list is empty. | |
cpl_type | cpl_propertylist_get_type (const cpl_propertylist *self, const char *name) |
Get the the type of a property list entry. | |
int | cpl_propertylist_contains (const cpl_propertylist *self, const char *name) |
Check whether a property is present in a property list. | |
cpl_error_code | cpl_propertylist_set_comment (cpl_propertylist *self, const char *name, const char *comment) |
Modify the comment field of the given property list entry. | |
cpl_error_code | cpl_propertylist_set_char (cpl_propertylist *self, const char *name, char value) |
Set the value of the given character property list entry. | |
cpl_error_code | cpl_propertylist_set_bool (cpl_propertylist *self, const char *name, int value) |
Set the value of the given boolean property list entry. | |
cpl_error_code | cpl_propertylist_set_int (cpl_propertylist *self, const char *name, int value) |
Set the value of the given integer property list entry. | |
cpl_error_code | cpl_propertylist_set_long (cpl_propertylist *self, const char *name, long value) |
Set the value of the given long property list entry. | |
cpl_error_code | cpl_propertylist_set_float (cpl_propertylist *self, const char *name, float value) |
Set the value of the given float property list entry. | |
cpl_error_code | cpl_propertylist_set_double (cpl_propertylist *self, const char *name, double value) |
Set the value of the given double property list entry. | |
cpl_error_code | cpl_propertylist_set_string (cpl_propertylist *self, const char *name, const char *value) |
Set the value of the given string property list entry. | |
cpl_property * | cpl_propertylist_get (cpl_propertylist *self, long index) |
Access property list elements by index. | |
const char * | cpl_propertylist_get_comment (const cpl_propertylist *self, const char *name) |
Get the comment of the given property list entry. | |
char | cpl_propertylist_get_char (const cpl_propertylist *self, const char *name) |
Get the character value of the given property list entry. | |
int | cpl_propertylist_get_bool (const cpl_propertylist *self, const char *name) |
Get the boolean value of the given property list entry. | |
int | cpl_propertylist_get_int (const cpl_propertylist *self, const char *name) |
Get the integer value of the given property list entry. | |
long | cpl_propertylist_get_long (const cpl_propertylist *self, const char *name) |
Get the long value of the given property list entry. | |
float | cpl_propertylist_get_float (const cpl_propertylist *self, const char *name) |
Get the float value of the given property list entry. | |
double | cpl_propertylist_get_double (const cpl_propertylist *self, const char *name) |
Get the double value of the given property list entry. | |
const char * | cpl_propertylist_get_string (const cpl_propertylist *self, const char *name) |
Get the string value of the given property list entry. | |
cpl_error_code | cpl_propertylist_insert_char (cpl_propertylist *self, const char *here, const char *name, char value) |
Insert a character value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_bool (cpl_propertylist *self, const char *here, const char *name, int value) |
Insert a boolean value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_int (cpl_propertylist *self, const char *here, const char *name, int value) |
Insert a integer value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_long (cpl_propertylist *self, const char *here, const char *name, long value) |
Insert a long value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_float (cpl_propertylist *self, const char *here, const char *name, float value) |
Insert a float value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_double (cpl_propertylist *self, const char *here, const char *name, double value) |
Insert a double value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_string (cpl_propertylist *self, const char *here, const char *name, const char *value) |
Insert a string value into a property list at the given position. | |
cpl_error_code | cpl_propertylist_insert_after_char (cpl_propertylist *self, const char *after, const char *name, char value) |
Insert a character value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_bool (cpl_propertylist *self, const char *after, const char *name, int value) |
Insert a boolean value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_int (cpl_propertylist *self, const char *after, const char *name, int value) |
Insert a integer value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_long (cpl_propertylist *self, const char *after, const char *name, long value) |
Insert a long value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_float (cpl_propertylist *self, const char *after, const char *name, float value) |
Insert a float value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_double (cpl_propertylist *self, const char *after, const char *name, double value) |
Insert a double value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_insert_after_string (cpl_propertylist *self, const char *after, const char *name, const char *value) |
Insert a string value into a property list after the given position. | |
cpl_error_code | cpl_propertylist_prepend_char (cpl_propertylist *self, const char *name, char value) |
Prepend a character value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_bool (cpl_propertylist *self, const char *name, int value) |
Prepend a boolean value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_int (cpl_propertylist *self, const char *name, int value) |
Prepend a integer value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_long (cpl_propertylist *self, const char *name, long value) |
Prepend a long value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_float (cpl_propertylist *self, const char *name, float value) |
Prepend a float value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_double (cpl_propertylist *self, const char *name, double value) |
Prepend a double value to a property list. | |
cpl_error_code | cpl_propertylist_prepend_string (cpl_propertylist *self, const char *name, const char *value) |
Prepend a string value to a property list. | |
cpl_error_code | cpl_propertylist_append_char (cpl_propertylist *self, const char *name, char value) |
Append a character value to a property list. | |
cpl_error_code | cpl_propertylist_append_bool (cpl_propertylist *self, const char *name, int value) |
Append a boolean value to a property list. | |
cpl_error_code | cpl_propertylist_append_int (cpl_propertylist *self, const char *name, int value) |
Append an integer value to a property list. | |
cpl_error_code | cpl_propertylist_append_long (cpl_propertylist *self, const char *name, long value) |
Append a long value to a property list. | |
cpl_error_code | cpl_propertylist_append_float (cpl_propertylist *self, const char *name, float value) |
Append a float value to a property list. | |
cpl_error_code | cpl_propertylist_append_double (cpl_propertylist *self, const char *name, double value) |
Append a double value to a property list. | |
cpl_error_code | cpl_propertylist_append_string (cpl_propertylist *self, const char *name, const char *value) |
Append a string value to a property list. | |
int | cpl_propertylist_erase (cpl_propertylist *self, const char *name) |
Erase the given property from a property list. | |
int | cpl_propertylist_erase_regexp (cpl_propertylist *self, const char *regexp) |
Erase all properties with name matching a given regular expression. | |
void | cpl_propertylist_empty (cpl_propertylist *self) |
Remove all properties from a property list. | |
cpl_error_code | cpl_propertylist_update_char (cpl_propertylist *self, const char *name, char value) |
Update a property list with a character value. | |
cpl_error_code | cpl_propertylist_update_bool (cpl_propertylist *self, const char *name, int value) |
Update a property list with a boolean value. | |
cpl_error_code | cpl_propertylist_update_int (cpl_propertylist *self, const char *name, int value) |
Update a property list with a integer value. | |
cpl_error_code | cpl_propertylist_update_long (cpl_propertylist *self, const char *name, long value) |
Update a property list with a long value. | |
cpl_error_code | cpl_propertylist_update_float (cpl_propertylist *self, const char *name, float value) |
Update a property list with a float value. | |
cpl_error_code | cpl_propertylist_update_double (cpl_propertylist *self, const char *name, double value) |
Update a property list with a double value. | |
cpl_error_code | cpl_propertylist_update_string (cpl_propertylist *self, const char *name, const char *value) |
Update a property list with a string value. | |
cpl_error_code | cpl_propertylist_copy_property (cpl_propertylist *self, const cpl_propertylist *other, const char *name) |
Copy a property from another property list. | |
cpl_error_code | cpl_propertylist_copy_property_regexp (cpl_propertylist *self, const cpl_propertylist *other, const char *regexp) |
Copy properties matching a regular expression from another property list. | |
cpl_propertylist * | cpl_propertylist_load (const char *name, int index) |
Create a property list from a file. |
#include <cpl_propertylist.h>
|
The opaque property list data type.
|
|
Append a boolean value to a property list.
The function creates a new boolean property with name name and value value. The property is appended to the property list self. |
|
Append a character value to a property list.
The function creates a new character property with name name and value value. The property is appended to the property list self. |
|
Append a double value to a property list.
The function creates a new double property with name name and value value. The property is appended to the property list self. |
|
Append a float value to a property list.
The function creates a new float property with name name and value value. The property is appended to the property list self. |
|
Append an integer value to a property list.
The function creates a new integer property with name name and value value. The property is appended to the property list self. |
|
Append a long value to a property list.
The function creates a new long property with name name and value value. The property is appended to the property list self. |
|
Append a string value to a property list.
The function creates a new string property with name name and value value. The property is appended to the property list self. |
|
Check whether a property is present in a property list.
The function searches the property list self for a property with the name name and reports whether it was found or not. |
|
Copy a property from another property list.
The function copies the property name from the property list other to the property list self. If the property list self does not already contain a property name the property is appended to self. If a property name exists already in self the function overwrites the contents of this property if and only if this property is of the same type as the property to be copied from other. |
|
Copy properties matching a regular expression from another property list.
The function copies all properties whose names matches the regular expression regexp from the property list other to the property list self. The function expects POSIX 1003.2 compliant extended regular expressions. If the property list self does not already contain one of the properties to be copied this property is appended to self. If a property to be copied exists already in self the function overwrites the contents of this property. Before properties are copied from the property list other to self the types of the properties are checked and if any type mismatch is detected the function stops processing immediately. The property list self is not at all modified in this case.
|
|
Destroy a property list.
|
|
Create a copy of the given property list.
The function creates a deep copy of the given property list self, i.e the created copy and the original property list do not share any resources. |
|
Remove all properties from a property list.
The function removes all properties from self. Each property is properly deallocated. After calling this function self is empty. |
|
Erase the given property from a property list.
The function searches the property with the name name in the property list self and removes it. The property is destroyed. If self contains multiple duplicates of a property named name, only the first one is erased. |
|
Erase all properties with name matching a given regular expression.
The function searches for all the properties matching regexp in the list self and removes them. The properties are destroyed. The function expects POSIX 1003.2 compliant extended regular expressions. |
|
Access property list elements by index.
The function returns a handle for the property list element, the property, with the index index. Numbering of property list elements extends from 0 to cpl_propertylist_get_size() - 1. If index is less than 0 or greater equal than cpl_propertylist_get_size() the function returns |
|
Get the boolean value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its boolean value is returned. |
|
Get the character value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its character value is returned. |
|
Get the comment of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its comment string is returned. If an entry with the name name is not found, or if the entry has no comment the function returns |
|
Get the double value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its double value is returned. |
|
Get the float value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its float value is returned. |
|
Get the integer value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its integer value is returned. |
|
Get the long value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its long value is returned. |
|
Get the current size of a property list.
The function reports the current number of elements stored in the property list self. |
|
Get the string value of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, a handle to its string value is returned. |
|
Get the the type of a property list entry.
The function returns the type of the value stored in self with the name name. |
|
Insert a boolean value into a property list after the given position.
The function creates a new boolean property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a character value into a property list after the given position.
The function creates a new character property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a double value into a property list after the given position.
The function creates a new double property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a float value into a property list after the given position.
The function creates a new float property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a integer value into a property list after the given position.
The function creates a new integer property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a long value into a property list after the given position.
The function creates a new long property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a string value into a property list after the given position.
The function creates a new string property with name name and value value. The property is inserted into the property list self after the property named after. |
|
Insert a boolean value into a property list at the given position.
The function creates a new boolean property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a character value into a property list at the given position.
The function creates a new character property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a double value into a property list at the given position.
The function creates a new double property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a float value into a property list at the given position.
The function creates a new float property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a integer value into a property list at the given position.
The function creates a new integer property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a long value into a property list at the given position.
The function creates a new long property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Insert a string value into a property list at the given position.
The function creates a new string property with name name and value value. The property is inserted into the property list self at the position of the property named here. |
|
Check whether a property list is empty.
The function checks if self contains any properties. |
|
Create a property list from a file.
The function reads the properties of the data set with index index from the file name. Currently only the FITS file format is supported, The property list is created by reading the FITS keywords from extension index. The numbering of the data sections starts from 0. When creating the property list from a FITS header, any keyword without a value like undefined keywords for instance are not transformed into a property. |
|
Create an empty property list.
|
|
Prepend a boolean value to a property list.
The function creates a new boolean property with name name and value value. The property is prepended to the property list self. |
|
Prepend a character value to a property list.
The function creates a new character property with name name and value value. The property is prepended to the property list self. |
|
Prepend a double value to a property list.
The function creates a new double property with name name and value value. The property is prepended to the property list self. |
|
Prepend a float value to a property list.
The function creates a new float property with name name and value value. The property is prepended to the property list self. |
|
Prepend a integer value to a property list.
The function creates a new integer property with name name and value value. The property is prepended to the property list self. |
|
Prepend a long value to a property list.
The function creates a new long property with name name and value value. The property is prepended to the property list self. |
|
Prepend a string value to a property list.
The function creates a new string property with name name and value value. The property is prepended to the property list self. |
|
Set the value of the given boolean property list entry.
The function searches the property list self for a property named name. If it is present in the list, its boolean value is replaced with the boolean value. |
|
Set the value of the given character property list entry.
The function searches the property list self for a property named name. If it is present in the list, its character value is replaced with the character value. |
|
Modify the comment field of the given property list entry.
The function searches the property list self for a property named name. If it is present in the list, its comment is replaced by the string comment. The provided comment string may be |
|
Set the value of the given double property list entry.
The function searches the property list self for a property named name. If it is present in the list, its double value is replaced with the double value. |
|
Set the value of the given float property list entry.
The function searches the property list self for a property named name. If it is present in the list, its float value is replaced with the float value. |
|
Set the value of the given integer property list entry.
The function searches the property list self for a property named name. If it is present in the list, its integer value is replaced with the integer value. |
|
Set the value of the given long property list entry.
The function searches the property list self for a property named name. If it is present in the list, its long value is replaced with the long value. |
|
Set the value of the given string property list entry.
The function searches the property list self for a property named name. If it is present in the list, its string value is replaced with the string value. |
|
Update a property list with a boolean value.
The function updates the property list self with the boolean value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a character value.
The function updates the property list self with the character value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a double value.
The function updates the property list self with the double value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a float value.
The function updates the property list self with the float value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a integer value.
The function updates the property list self with the integer value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a long value.
The function updates the property list self with the long value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |
|
Update a property list with a string value.
The function updates the property list self with the string value value. This means, if a property with the name name exists already its value is updated, otherwise a property with the name name is created and added to self. The update will fail if a property with the name name exists already which is not of type |