rave_properties.h File Reference

Property handling This object supports RAVE_OBJECT_CLONE. More...

#include "rave_value.h"
#include "rave_object.h"
#include "odim_sources.h"

Go to the source code of this file.

Typedefs
typedef struct _RaveProperties_t	RaveProperties_t
	Defines the area registry.

Functions
RaveProperties_t *	RaveProperties_load (const char *filename)
	Simplified loading function, takes filename pointing to a json file containing the properties to load.
int	RaveProperties_set (RaveProperties_t *self, const char *name, RaveValue_t *value)
	Sets the property in the table.
RaveValue_t *	RaveProperties_get (RaveProperties_t *self, const char *name)
	Returns the value with specified name.
int	RaveProperties_hasProperty (RaveProperties_t *self, const char *name)
	Returns if the set contains the specified property.
void	RaveProperties_remove (RaveProperties_t *self, const char *name)
	Removes the property from the set.
int	RaveProperties_size (RaveProperties_t *self)
	Returns the number of properties.
void	RaveProperties_setOdimSources (RaveProperties_t *self, OdimSources_t *sources)
	Sets the odim sources to the rave properties.
OdimSources_t *	RaveProperties_getOdimSources (RaveProperties_t *self)

Variables
RaveCoreObjectType	RaveProperties_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Property handling This object supports RAVE_OBJECT_CLONE.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2025-02-14

Typedef Documentation

RaveProperties_t

typedef struct _RaveProperties_t RaveProperties_t

Defines the area registry.

Function Documentation

RaveProperties_get()

RaveValue_t * RaveProperties_get	(	RaveProperties_t *	self,
		const char *	name )

Returns the value with specified name.

Parameters

[in]	self	- self
[in]	name	- name of property

Returns

the value or NULL if not found

RaveProperties_getOdimSources()

OdimSources_t * RaveProperties_getOdimSources

(

RaveProperties_t *

self

)

Parameters

[in]

self

- self

Returns

the odim sources

RaveProperties_hasProperty()

int RaveProperties_hasProperty	(	RaveProperties_t *	self,
		const char *	name )

Returns if the set contains the specified property.

Parameters

[in]	self	- self
[in]	name	- name of property

Returns

1 if found, otherwise 0

RaveProperties_load()

RaveProperties_t * RaveProperties_load

(

const char *

filename

)

Simplified loading function, takes filename pointing to a json file containing the properties to load.

Note that the configuration must be defined as a object, i.e. { }

Parameters

[in]

filename

- the area file name

Returns

the rave properties

RaveProperties_remove()

void RaveProperties_remove	(	RaveProperties_t *	self,
		const char *	name )

Removes the property from the set.

Parameters

[in]	self	- self
[in]	name	- name of property

RaveProperties_set()

int RaveProperties_set	(	RaveProperties_t *	self,
		const char *	name,
		RaveValue_t *	value )

Sets the property in the table.

Parameters

[in]	self	- self
[in]	name	- name of property
[in]	value	- the value

RaveProperties_setOdimSources()

void RaveProperties_setOdimSources	(	RaveProperties_t *	self,
		OdimSources_t *	sources )

Sets the odim sources to the rave properties.

Parameters

[in]	self	- self
[in]	sources	- the odim sources

RaveProperties_size()

int RaveProperties_size

(

RaveProperties_t *

self

)

Returns the number of properties.

Parameters

[in]

self

- self

Returns

the number of properties

Variable Documentation

RaveProperties_TYPE

RaveCoreObjectType RaveProperties_TYPE

extern

Type definition to use when creating a rave object.