compositefilter.h File Reference

A filter for matching composite arguments. More...

#include "compositearguments.h"
#include "rave_proj.h"
#include "rave_object.h"
#include "rave_attribute.h"
#include "raveobject_list.h"

Go to the source code of this file.

Typedefs
typedef struct _CompositeFilter_t	CompositeFilter_t
	Defines a Geographical Area.

Functions
int	CompositeFilter_setProductsArray (CompositeFilter_t *filter, const char *products[], int nrproducts)
	Sets the products that this filter should match.
int	CompositeFilter_setProductsList (CompositeFilter_t *filter, RaveList_t *products)
	Sets the products that this filter should match.
int	CompositeFilter_getProductCount (CompositeFilter_t *filter)
	Returns the number of products set in filter.
const char *	CompositeFilter_getProduct (CompositeFilter_t *filter, int index)
	Returns the product string at specified position.
int	CompositeFilter_setQuantitiesArray (CompositeFilter_t *filter, const char *quantities[], int nrquantities)
	Sets the quantities that this filter should match.
int	CompositeFilter_setQuantitiesList (CompositeFilter_t *filter, RaveList_t *quantities)
	Sets the quantities that this filter should match.
int	CompositeFilter_getQuantityCount (CompositeFilter_t *filter)
	Returns the number of quantities set in filter.
const char *	CompositeFilter_getQuantity (CompositeFilter_t *filter, int index)
	Returns the quantity string at specified position.
int	CompositeFilter_setInterpolationMethodsArray (CompositeFilter_t *filter, const char *methods[], int nrmethods)
	Sets the interpolation methods that this filter should match.
int	CompositeFilter_setInterpolationMethodsList (CompositeFilter_t *filter, RaveList_t *methods)
	Sets the interpolation methods that this filter should match.
int	CompositeFilter_getInterpolationMethodCount (CompositeFilter_t *filter)
	Returns the number of interpolation methods set in filter.
const char *	CompositeFilter_getInterpolationMethod (CompositeFilter_t *filter, int index)
	Returns the interpolation method at specified position.
int	CompositeFilter_match (CompositeFilter_t *filter, CompositeArguments_t *arguments)
	Matches the filter against the arguments.

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

Detailed Description

A filter for matching composite arguments.

This object supports RAVE_OBJECT_CLONE.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2025-01-27

Typedef Documentation

CompositeFilter_t

typedef struct _CompositeFilter_t CompositeFilter_t

Defines a Geographical Area.

Function Documentation

CompositeFilter_getInterpolationMethod()

const char * CompositeFilter_getInterpolationMethod	(	CompositeFilter_t *	filter,
		int	index )

Returns the interpolation method at specified position.

Parameters

[in]	filter	- self
[in]	index	- the index

Returns

the string at specified index

CompositeFilter_getInterpolationMethodCount()

int CompositeFilter_getInterpolationMethodCount

(

CompositeFilter_t *

filter

)

Returns the number of interpolation methods set in filter.

Parameters

[in]

filter

- self

Returns

the number of interpolation methods

CompositeFilter_getProduct()

const char * CompositeFilter_getProduct	(	CompositeFilter_t *	filter,
		int	index )

Returns the product string at specified position.

Parameters

[in]	filter	- self
[in]	index	- the index

Returns

the string at specified index

CompositeFilter_getProductCount()

int CompositeFilter_getProductCount

(

CompositeFilter_t *

filter

)

Returns the number of products set in filter.

Parameters

[in]

filter

- self

Returns

the number of products

CompositeFilter_getQuantity()

const char * CompositeFilter_getQuantity	(	CompositeFilter_t *	filter,
		int	index )

Returns the quantity string at specified position.

Parameters

[in]	filter	- self
[in]	index	- the index

Returns

the string at specified index

CompositeFilter_getQuantityCount()

int CompositeFilter_getQuantityCount

(

CompositeFilter_t *

filter

)

Returns the number of quantities set in filter.

Parameters

[in]

filter

- self

Returns

the number of quantities

CompositeFilter_match()

int CompositeFilter_match	(	CompositeFilter_t *	filter,
		CompositeArguments_t *	arguments )

Matches the filter against the arguments.

Parameters

[in]	filter	- self
[in]	arguments	- the arguments

Returns

1 if it is matching, otherwise 0

Always assume that we have a match, then if set it to False on failure.

CompositeFilter_setInterpolationMethodsArray()

int CompositeFilter_setInterpolationMethodsArray	(	CompositeFilter_t *	filter,
		const char *	methods[],
		int	nrmethods )

Sets the interpolation methods that this filter should match.

Parameters

[in]	filter	- self
[in]	methods	- an array of interpolation methods
[in]	nrmethods	- the number of interpolation methods in array

Returns

1 on success, otherwise 0

CompositeFilter_setInterpolationMethodsList()

int CompositeFilter_setInterpolationMethodsList	(	CompositeFilter_t *	filter,
		RaveList_t *	methods )

Sets the interpolation methods that this filter should match.

Parameters

[in]	filter	- self
[in]	methods	- a list of interpolation methods

Returns

1 on success, otherwise 0

CompositeFilter_setProductsArray()

int CompositeFilter_setProductsArray	(	CompositeFilter_t *	filter,
		const char *	products[],
		int	nrproducts )

Sets the products that this filter should match.

Parameters

[in]	filter	- self
[in]	products	- an array of product strings
[in]	nrproducts	- the number of products in array

Returns

1 on success, otherwise 0

CompositeFilter_setProductsList()

int CompositeFilter_setProductsList	(	CompositeFilter_t *	filter,
		RaveList_t *	products )

Sets the products that this filter should match.

Parameters

[in]	filter	- self
[in]	products	- the list of strings

Returns

1 on success, otherwise 0

CompositeFilter_setQuantitiesArray()

int CompositeFilter_setQuantitiesArray	(	CompositeFilter_t *	filter,
		const char *	quantities[],
		int	nrquantities )

Sets the quantities that this filter should match.

Parameters

[in]	filter	- self
[in]	quantities	- an array of quantities
[in]	nrquantities	- the number of quantities in array

Returns

1 on success, otherwise 0

CompositeFilter_setQuantitiesList()

int CompositeFilter_setQuantitiesList	(	CompositeFilter_t *	filter,
		RaveList_t *	quantities )

Sets the quantities that this filter should match.

Parameters

[in]	filter	- self
[in]	quantities	- a list of quantities

Returns

1 on success, otherwise 0

Variable Documentation

CompositeFilter_TYPE

RaveCoreObjectType CompositeFilter_TYPE

extern

Type definition to use when creating a rave object.