legacycompositegeneratorfactory.c File Reference

Provides functionality for creating composites. More...

#include "legacycompositegeneratorfactory.h"
#include "compositearguments.h"
#include "polarvolume.h"
#include "rave_attribute.h"
#include "rave_list.h"
#include "rave_object.h"
#include "rave_properties.h"
#include "raveobject_list.h"
#include "rave_types.h"
#include "rave_debug.h"
#include "rave_alloc.h"
#include "rave_utilities.h"
#include "composite.h"
#include <strings.h>
#include <string.h>
#include <stdio.h>
#include "poo_composite_algorithm.h"

Classes
struct	_LegacyCompositeGeneratorFactory_t
	The Legacy composite generator factory. More...
struct	InterpolationMethodMapping_t

Typedefs
typedef struct _LegacyCompositeGeneratorFactory_t	LegacyCompositeGeneratorFactory_t
	The Legacy composite generator factory.
typedef struct InterpolationMethodMapping_t	InterpolationMethodMapping_t

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

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

Detailed Description

Provides functionality for creating composites.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2024-10-10

Typedef Documentation

LegacyCompositeGeneratorFactory_t

typedef struct _LegacyCompositeGeneratorFactory_t LegacyCompositeGeneratorFactory_t

The Legacy composite generator factory.

Defines a Composite generator plugin.

Uses Composite_t to provide the functionality

Function Documentation

LegacyCompositeGeneratorFactory_canHandle()

int LegacyCompositeGeneratorFactory_canHandle	(	CompositeGeneratorFactory_t *	self,
		CompositeArguments_t *	arguments )

Returns

if this plugin can handle the generator request

LegacyCompositeGeneratorFactory_create()

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

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

Initial value:

= {
    "LegacyCompositeGeneratorFactory",
    sizeof(LegacyCompositeGeneratorFactory_t),
    LegacyCompositeGeneratorFactory_constructor,
    LegacyCompositeGeneratorFactory_destructor,
    LegacyCompositeGeneratorFactory_copyconstructor
}

Type definition to use when creating a rave object.