acqvacompositegeneratorfactory.h File Reference

Factory method for ACQVA composite generation. More...

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

Go to the source code of this file.

Functions
const char *	AcqvaCompositeGeneratorFactory_getName (CompositeGeneratorFactory_t *self)
const char *	AcqvaCompositeGeneratorFactory_getDefaultId (CompositeGeneratorFactory_t *self)
int	AcqvaCompositeGeneratorFactory_canHandle (CompositeGeneratorFactory_t *self, CompositeArguments_t *arguments)
int	AcqvaCompositeGeneratorFactory_setProperties (CompositeGeneratorFactory_t *self, RaveProperties_t *properties)
	Sets the factory with properties.
RaveProperties_t *	AcqvaCompositeGeneratorFactory_getProperties (CompositeGeneratorFactory_t *self)
	Returns properties from the factory.
Cartesian_t *	AcqvaCompositeGeneratorFactory_generate (CompositeGeneratorFactory_t *self, CompositeArguments_t *arguments)
CompositeGeneratorFactory_t *	AcqvaCompositeGeneratorFactory_create (CompositeGeneratorFactory_t *self)
	Return a new instance of the factory.

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

Detailed Description

Factory method for ACQVA composite generation.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2025-01-14

Function Documentation

AcqvaCompositeGeneratorFactory_canHandle()

int AcqvaCompositeGeneratorFactory_canHandle	(	CompositeGeneratorFactory_t *	self,
		CompositeArguments_t *	arguments )

Returns

if this factory can handle the generator request or not

AcqvaCompositeGeneratorFactory_create()

CompositeGeneratorFactory_t * AcqvaCompositeGeneratorFactory_create

(

CompositeGeneratorFactory_t *

self

)

Return a new instance of the factory.

Returns

1 on success otherwise 0

AcqvaCompositeGeneratorFactory_generate()

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

Returns

the result from the generation

AcqvaCompositeGeneratorFactory_getDefaultId()

const char * AcqvaCompositeGeneratorFactory_getDefaultId

(

CompositeGeneratorFactory_t *

self

)

Returns

the default id of this factory

AcqvaCompositeGeneratorFactory_getName()

const char * AcqvaCompositeGeneratorFactory_getName

(

CompositeGeneratorFactory_t *

self

)

Returns

the name of this plugin

AcqvaCompositeGeneratorFactory_getProperties()

RaveProperties_t * AcqvaCompositeGeneratorFactory_getProperties

(

CompositeGeneratorFactory_t *

self

)

Returns properties from the factory.

Parameters

[in]

self

- self

Returns

properties - the properties

AcqvaCompositeGeneratorFactory_setProperties()

int AcqvaCompositeGeneratorFactory_setProperties	(	CompositeGeneratorFactory_t *	self,
		RaveProperties_t *	properties )

Sets the factory with properties.

Parameters

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

Variable Documentation

AcqvaCompositeGeneratorFactory_TYPE

RaveCoreObjectType AcqvaCompositeGeneratorFactory_TYPE

extern

Type definition to use when creating a rave object.