Rasodmg Classes

Classes
class	r_Aligned_Tiling
	The r_Aligned_Tiling class is used to express the options for aligned tiling of r_Marray objects. More...
class	r_Collection< T >
	Basic class of a collection. More...
class	r_Database
	A database object must be instantiated and opened before starting any transaction which uses the database, and closed after ending these transactions. More...
class	r_Dir_Decompose
	The r_Dir_Decompose class is used to specify a decomposition on an n-dimensional cube (for use in r_Dir_Tiling). More...
class	r_Dir_Tiling
	This class implements the "Directional Tiling" tiling method. More...
class	r_GMarray
	The class represents a generic MDD in the sense that it is independent of the cell base type. More...
class	r_Interest_Tiling
	This class implements the "Interesting Areas" tiling algorithm. More...
class	r_Iterator< T >
	The template class r_Iterator defines the generic behavior for iteration. More...
class	r_Marray< T >
	The central class of the library for representing an MDD object is named r_Marray. More...
class	r_Object
	Through inheritance of this class, the type definer specifies that the subclass is capable of having persistent as well as transient instances. More...
class	r_OQL_Query
	The global function r_oql_execute() is used to invoke RasML queries. More...
class	r_Ref_Any
	The class r_Ref_Any is defined to support a reference to any type. More...
class	r_Ref< T >
	References of type r_Ref in many respects behave like C++ pointers but provide an additional mechanism that guarantees integrity in references to persistent objects. More...
class	r_Set< T >
	The class implements a set container. More...
class	r_Access
	This class represents an access pattern to a certain object. More...
class	r_Stat_Tiling
class	r_Storage_Layout
	The r_Storage_Layout class is used to express the storage options for r_Marray objects. More...
class	r_Tiling
	The r_Tiling class is used to specify in which way the tiling is done by the system. More...
class	r_No_Tiling
class	r_Size_Tiling
class	r_Dimension_Tiling
class	r_Transaction
	Transactions can be started, committed, aborted, and checkpointed. More...

Functions
void	r_oql_execute (r_OQL_Query &query, r_Set< r_Ref_Any > &result, r_Transaction *transaction=NULL)
	The free standing function r_oql_execute is called to execute a retrieval query. More...
void	r_oql_execute (r_OQL_Query &query, r_Set< r_Ref< r_GMarray >> &result, r_Transaction *transaction=NULL)
	The function is used to execute retrieval queries with the result set being of type r_Set< r_Ref< r_GMarray > >. More...
void	r_oql_execute (r_OQL_Query &query, r_Set< r_Ref_Any > &result, int dummy, r_Transaction *transaction=NULL)
	The free standing function r_oql_execute is called to execute an insert query that returns the OID that has been inserted. More...
void	r_oql_execute (r_OQL_Query &query, r_Transaction *transaction=NULL)
	The free standing function r_oql_execute is called to execute an update / delete query. More...

Detailed Description

Function Documentation

r_oql_execute() [1/4]

void r_oql_execute	(	r_OQL_Query &	query,
		r_Set< r_Ref< r_GMarray >> &	result,
		r_Transaction *	transaction = NULL
	)

The function is used to execute retrieval queries with the result set being of type r_Set< r_Ref< r_GMarray > >.

The function is supported for compatibility reasons only. We suggest to use the general function r_oql_execute able to maintain query results of any type. Important: If the transaction parameter is not provided this function is not thread-safe.

r_oql_execute() [2/4]

void r_oql_execute	(	r_OQL_Query &	query,
		r_Set< r_Ref_Any > &	result,
		int	dummy,
		r_Transaction *	transaction = NULL
	)

The free standing function r_oql_execute is called to execute an insert query that returns the OID that has been inserted.

The first parameter, query, is a reference to a r_OQL_Query object specifying the query to execute. The second parameter, result, is used for returning the result of the query. The query result is of type r_Set< r_Ref_Any >. The third parameter is a dummy parameter, it is used to differentiate from retrieval queries. The function used the same return values as the retrieval function above. Important: If the transaction parameter is not provided this function is not thread-safe.

If the function is not called within the scope of an opened database, a r_Error exception of kind r_Error_DatabaseClosed is raised. If it is called outside any transaction, the exception is of kind r_Error_TransactionNotOpen.

r_oql_execute() [3/4]

void r_oql_execute	(	r_OQL_Query &	query,
		r_Set< r_Ref_Any > &	result,
		r_Transaction *	transaction = NULL
	)

The free standing function r_oql_execute is called to execute a retrieval query.

The first parameter, query, is a reference to a r_OQL_Query object specifying the query to execute. The second parameter, result, is used for returning the result of the query. The query result is of type r_Set< r_Ref_Any >. Important: If the transaction parameter is not provided this function is not thread-safe.

If the function is not called within the scope of an opened database, a r_Error exception of kind r_Error_DatabaseClosed is raised. If it is called outside any transaction, the exception is of kind r_Error_TransactionNotOpen.

A complete list of all possible error kinds is given by the following table.

r_Error_ClientUnknown                 Client is not known by the server (earlier communication problems).
r_Error_DatabaseClosed                No database is not opened.
r_Error_TransactionNotOpen            Call is not within an active transaction.
r_Error_QueryParameterCountInvalid    At least one of the query parameters is not supplied with a value.
r_Error_TransferFailed                Other communication problem.
r_Error_QueryExecutionFailed          The execution of the query failed (further information is available
                                      in an error object of type r_Equery_execution).
r_Error_TypeInvalid                   Result base type doesn't match the template type.

r_oql_execute() [4/4]

void r_oql_execute	(	r_OQL_Query &	query,
		r_Transaction *	transaction = NULL
	)

The free standing function r_oql_execute is called to execute an update / delete query.

It is also used by older ( < v9.1 ) clients for insert queries. The first parameter, query, is a reference to a r_OQL_Query object specifying the query to execute. Important: If the transaction parameter is not provided this function is not thread-safe.

If the function is not called within the scope of an opened database, a r_Error exception of kind r_Error_DatabaseClosed is raised. If it is called outside any transaction, the exception is of kind r_Error_TransactionNotOpen.

A complete list of all possible error kinds is given by the following table.

r_Error_ClientUnknown                 Client is not known by the server (earlier communication problems).
r_Error_DatabaseClosed                No database is not opened.
r_Error_TransactionNotOpen            Call is not within an active transaction.
r_Error_QueryParameterCountInvalid    At least one of the query parameters is not supplied with a value.
r_Error_TransferFailed                Other communication problem.
r_Error_QueryExecutionFailed          The execution of the query failed (further information is available
                                      in an error object of type r_Equery_execution).