NormalisedEvent.h File Reference

Normalised Event. More...

#include <AP_Types.h>
#include <IAF_Platform.h>

Go to the source code of this file.

Classes
struct	AP_NormalisedEventIterator_Functions
	AP_NormalisedEventIterator_Functions. More...
struct	AP_NormalisedEventIterator
	AP_NormalisedEventIterator. More...
struct	AP_NormalisedEvent_Functions
	AP_NormalisedEvent_Functions. More...
struct	AP_NormalisedEvent
	AP_NormalisedEvent. More...

Typedefs
typedef const AP_char8 *	AP_NormalisedEventKey
	Event field names (keys) are NUL-terminated C character strings. More...
typedef const AP_char8 *	AP_NormalisedEventValue
	Event field values are NUL-terminated C character strings. More...

Functions
AP_IAFCORE_API void AP_IAFCORE_CALL	AP_NormalisedEventIterator_dtor (AP_NormalisedEventIterator *it)
	AP_NormalisedEventIterator_dtor. More...
AP_IAFCORE_API AP_NormalisedEvent *AP_IAFCORE_CALL	AP_NormalisedEvent_ctor ()
	AP_NormalisedEvent_ctor. More...
AP_IAFCORE_API AP_NormalisedEvent *AP_IAFCORE_CALL	AP_NormalisedEvent_copy (AP_NormalisedEvent *old)
	AP_NormalisedEvent_copy. More...
AP_IAFCORE_API void AP_IAFCORE_CALL	AP_NormalisedEvent_dtor (AP_NormalisedEvent *event)
	AP_NormalisedEvent_dtor. More...

Detailed Description

Normalised Event.

External (client-visible) interface to the normalised event type used to pass event into and out of the IAF Semantic Mapper component. Normalised events are essentially just dictionaries of name-value pairs, where both the names and values are character strings. Each name-value pair nominally represents the name and content of a single field from an event, but users of the class are free to invent custom naming schemes to represent more complex event structures. Names must be unique within a given event. Values may be empty or missing.

Please note that normalised events are NOT thread-safe. If your code will be acessing the same normalised event object (or associated iterators) from multiple threads, you must implement your own thread synchronisation to prevent concurrent modification of the objects.

Typedef Documentation

AP_NormalisedEventKey

typedef const AP_char8* AP_NormalisedEventKey

Event field names (keys) are NUL-terminated C character strings.

AP_NormalisedEventValue

typedef const AP_char8* AP_NormalisedEventValue

Event field values are NUL-terminated C character strings.

Function Documentation

AP_NormalisedEvent_copy()

AP_IAFCORE_API AP_NormalisedEvent* AP_IAFCORE_CALL AP_NormalisedEvent_copy

(

AP_NormalisedEvent *

old

)

AP_NormalisedEvent_copy.

Creates a deep copy of an existing normalised event instance.

Parameters

old	The existing normalised event to be copied.

Returns

Pointer to a new normalised event instance whose contents are an exact copy of old, or NULL if the new instance could not be created for some reason.

AP_NormalisedEvent_ctor()

AP_IAFCORE_API AP_NormalisedEvent* AP_IAFCORE_CALL AP_NormalisedEvent_ctor

(

)

AP_NormalisedEvent_ctor.

Constructs a new normalised event instance.

Returns

Pointer to a new normalised event instance, or NULL if the new instance could not be created for some reason.

AP_NormalisedEvent_dtor()

AP_IAFCORE_API void AP_IAFCORE_CALL AP_NormalisedEvent_dtor

(

AP_NormalisedEvent *

event

)

AP_NormalisedEvent_dtor.

Destroys a normalised event object. This function should be called as soon as the event is no longer required, to free any resources it occupies.

Parameters

event

The event to be destroyed.

AP_NormalisedEventIterator_dtor()

AP_IAFCORE_API void AP_IAFCORE_CALL AP_NormalisedEventIterator_dtor

(

AP_NormalisedEventIterator *

it

)

AP_NormalisedEventIterator_dtor.

Destroys a normalised event iterator object. This function should be called as soon as the iterator is no longer required, to free any resources it occupies.

Parameters

it	The iterator to be destroyed.