The NEAREST composite factory. More...

#include "compositearguments.h"
#include "compositegeneratorfactory.h"
#include "compositegenerator.h"
#include "cartesian.h"
#include "rave_object.h"
#include "rave_types.h"
#include "raveobject_list.h"
#include "rave_field.h"

Functions
const char *	NearestCompositeGeneratorFactory_getName (CompositeGeneratorFactory_t *self)
const char *	NearestCompositeGeneratorFactory_getDefaultId (CompositeGeneratorFactory_t *self)
int	NearestCompositeGeneratorFactory_canHandle (CompositeGeneratorFactory_t self, CompositeArguments_t arguments)
int	NearestCompositeGeneratorFactory_setProperties (CompositeGeneratorFactory_t self, RaveProperties_t properties)
	Sets the factory with properties.
RaveProperties_t *	NearestCompositeGeneratorFactory_getProperties (CompositeGeneratorFactory_t *self)
	Returns properties from the factory.
Cartesian_t *	NearestCompositeGeneratorFactory_generate (CompositeGeneratorFactory_t self, CompositeArguments_t arguments)
CompositeGeneratorFactory_t *	NearestCompositeGeneratorFactory_create (CompositeGeneratorFactory_t *self)
	The factory creation method.

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

Detailed Description

The NEAREST composite factory.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2025-01-10

Function Documentation

◆ NearestCompositeGeneratorFactory_canHandle()

int NearestCompositeGeneratorFactory_canHandle	(	CompositeGeneratorFactory_t *	self,
		CompositeArguments_t *	arguments )

Returns: if this factory can handle the generator request or not; if this plugin can handle the generator request

◆ NearestCompositeGeneratorFactory_create()

CompositeGeneratorFactory_t * NearestCompositeGeneratorFactory_create ( CompositeGeneratorFactory_t * self )

The factory creation method.

The initializing function so that we know what composite generator we are working with.

Returns: a new instance of the factory on success

The factory creation method.

Note, this function will be called by the composite module and will override any previous calls.

Returns: 1 on success otherwise 0

◆ NearestCompositeGeneratorFactory_generate()

Cartesian_t * NearestCompositeGeneratorFactory_generate	(	CompositeGeneratorFactory_t *	self,
		CompositeArguments_t *	arguments )

Returns: the result from the generation

◆ NearestCompositeGeneratorFactory_getDefaultId()

const char * NearestCompositeGeneratorFactory_getDefaultId ( CompositeGeneratorFactory_t * self )

Returns: the default id of this factory

◆ NearestCompositeGeneratorFactory_getName()

const char * NearestCompositeGeneratorFactory_getName ( CompositeGeneratorFactory_t * self )

Returns: the name of this factory; the unique name for this composite generator plugin

◆ NearestCompositeGeneratorFactory_getProperties()

RaveProperties_t * NearestCompositeGeneratorFactory_getProperties ( CompositeGeneratorFactory_t * self )

Returns properties from the factory.

Parameters

[in] self - self

Returns: properties - the properties

◆ NearestCompositeGeneratorFactory_setProperties()

int NearestCompositeGeneratorFactory_setProperties	(	CompositeGeneratorFactory_t *	self,
		RaveProperties_t *	properties )

Sets the factory with properties.

Parameters

[in]	self	- self
[in]	properties	- the properties

Variable Documentation

◆ NearestCompositeGeneratorFactory_TYPE

RaveCoreObjectType NearestCompositeGeneratorFactory_TYPE

extern

Type definition to use when creating a rave object.

Functions

Variables