legacycompositegeneratorfactory.h File Reference

Interface for defining your own compositing factory method. 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"

Go to the source code of this file.

Functions
const char *	LegacyCompositeGeneratorFactory_getName (CompositeGeneratorFactory_t *self)
const char *	LegacyCompositeGeneratorFactory_getDefaultId (CompositeGeneratorFactory_t *self)
int	LegacyCompositeGeneratorFactory_canHandle (CompositeGeneratorFactory_t *self, CompositeArguments_t *arguments)
int	LegacyCompositeGeneratorFactory_setProperties (CompositeGeneratorFactory_t *self, RaveProperties_t *properties)
	Sets the factory with properties.
RaveProperties_t *	LegacyCompositeGeneratorFactory_getProperties (CompositeGeneratorFactory_t *self)
	Returns properties from the factory.
Cartesian_t *	LegacyCompositeGeneratorFactory_generate (CompositeGeneratorFactory_t *self, CompositeArguments_t *arguments)
CompositeGeneratorFactory_t *	LegacyCompositeGeneratorFactory_create (CompositeGeneratorFactory_t *self)
	The factory creation method.

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

Detailed Description

Interface for defining your own compositing factory method.

If CompositeGeneratorFactory_canHandle(...) returns true, then CompositeGeneratorFactory_generate(....) will be called.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2024-10-10

Function Documentation

LegacyCompositeGeneratorFactory_canHandle()

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

LegacyCompositeGeneratorFactory_create()

CompositeGeneratorFactory_t * LegacyCompositeGeneratorFactory_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

LegacyCompositeGeneratorFactory_generate()

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

Returns

the result from the generation

LegacyCompositeGeneratorFactory_getDefaultId()

const char * LegacyCompositeGeneratorFactory_getDefaultId

(

CompositeGeneratorFactory_t *

self

)

Returns

the default id of this factory

LegacyCompositeGeneratorFactory_getName()

const char * LegacyCompositeGeneratorFactory_getName

(

CompositeGeneratorFactory_t *

self

)

Returns

the name of this factory

the unique name for this composite generator plugin

LegacyCompositeGeneratorFactory_getProperties()

RaveProperties_t * LegacyCompositeGeneratorFactory_getProperties

(

CompositeGeneratorFactory_t *

self

)

Returns properties from the factory.

Parameters

[in]

self

- self

Returns

properties - the properties

LegacyCompositeGeneratorFactory_setProperties()

int LegacyCompositeGeneratorFactory_setProperties	(	CompositeGeneratorFactory_t *	self,
		RaveProperties_t *	properties )

Sets the factory with properties.

Parameters

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

Variable Documentation

LegacyCompositeGeneratorFactory_TYPE

RaveCoreObjectType LegacyCompositeGeneratorFactory_TYPE

extern

Type definition to use when creating a rave object.