nearestcompositegeneratorfactory.c File Reference

The NEAREST composite factory. More...

#include "nearestcompositegeneratorfactory.h"
#include "compositeenginefunctions.h"
#include "cartesian.h"
#include "composite_utils.h"
#include "compositearguments.h"
#include "compositeengine.h"
#include "compositeengineqc.h"
#include "polarvolume.h"
#include "rave_attribute.h"
#include "rave_list.h"
#include "rave_object.h"
#include "rave_properties.h"
#include "rave_value.h"
#include "raveobject_hashtable.h"
#include "raveobject_list.h"
#include "rave_types.h"
#include "rave_debug.h"
#include "rave_alloc.h"
#include "rave_utilities.h"
#include "raveutil.h"
#include "composite.h"
#include <strings.h>
#include <string.h>
#include <stdio.h>

Classes
struct	_NearestCompositeGeneratorFactory_t
	Nearest composite generator factory that can handle PPI, CAPPI, PCAPPI, MAX and PMAX using nearest neighbour. More...

Typedefs
typedef struct _NearestCompositeGeneratorFactory_t	NearestCompositeGeneratorFactory_t
	Nearest composite generator factory that can handle PPI, CAPPI, PCAPPI, MAX and PMAX using nearest neighbour.

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 initializing function so that we know what composite generator we are working with.

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

2024-10-10

Typedef Documentation

NearestCompositeGeneratorFactory_t

typedef struct _NearestCompositeGeneratorFactory_t NearestCompositeGeneratorFactory_t

Nearest composite generator factory that can handle PPI, CAPPI, PCAPPI, MAX and PMAX using nearest neighbour.

Defines a Composite generator plugin.

Function Documentation

NearestCompositeGeneratorFactory_canHandle()

int NearestCompositeGeneratorFactory_canHandle	(	CompositeGeneratorFactory_t *	self,
		CompositeArguments_t *	arguments )

Returns

if this plugin can handle the generator request

NearestCompositeGeneratorFactory_create()

CompositeGeneratorFactory_t * NearestCompositeGeneratorFactory_create

(

CompositeGeneratorFactory_t *

self

)

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

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 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

Initial value:

= {
    "NearestCompositeGeneratorFactory",
    sizeof(NearestCompositeGeneratorFactory_t),
    NearestCompositeGeneratorFactory_constructor,
    NearestCompositeGeneratorFactory_destructor,
    NearestCompositeGeneratorFactory_copyconstructor
}

Type definition to use when creating a rave object.