jazz_bebop::Caster Class Reference

Caster: An optional converter of the output. More...

#include <space.h>

Public Member Functions
	Caster (pBaseAPI api)
	The constructor for a Caster.
virtual StatusCode	get (pTransaction &p_txn, pBlock p_block)
	Convert a block doing whatever the caster does.

Data Fields
stdName	name
	The name of the Caster.

Detailed Description

Caster: An optional converter of the output.

This is a function that converts the result returned by a Space.get_row(). It can be a conversion from text to tokens or vice versa, from wave to aperiodic, a sentence embedding, an image format converter, etc. Something deterministic. Is is identified by a name and used in a query with the AS keyword.

The collection of all the available Caster descendants is managed by a Casters object.

Constructor & Destructor Documentation

Caster()

jazz_bebop::Caster::Caster ( pBaseAPI  api )

inline

The constructor for a Caster.

Parameters

api	A BaseAPI. It is used to create new blocks.

Member Function Documentation

get()

virtual StatusCode jazz_bebop::Caster::get ( pTransaction &  p_txn, pBlock  p_block  )

inlinevirtual

Convert a block doing whatever the caster does.

Parameters

p_txn	The transaction that contains the new block.
p_block	The block to convert.

Returns

SERVICE_NO_ERROR if successful, an error code otherwise.

---

The documentation for this class was generated from the following file:

• space.h