Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Data Structures | Macros | Typedefs
afw_adaptor_impl_index_cursor

Modules

 afw_adaptor_impl_index_cursor
 

Data Structures

struct  afw_adaptor_impl_index_cursor_s
 Interface afw_adaptor_impl_index_cursor public struct. More...
 
struct  afw_adaptor_impl_index_cursor_inf_s
 Interface afw_adaptor_impl_index_cursor_inf_s struct. More...
 

Macros

#define AFW_ADAPTOR_IMPL_INDEX_CURSOR_INTERFACE_NAME   "afw_adaptor_impl_index_cursor"
 define for interface afw_adaptor_impl_index_cursor name.
 
#define afw_adaptor_impl_index_cursor_release(instance, xctx)
 Call method release of interface afw_adaptor_impl_index_cursor. More...
 
#define afw_adaptor_impl_index_cursor_get_next_object(instance, pool, xctx)
 Call method get_next_object of interface afw_adaptor_impl_index_cursor. More...
 
#define afw_adaptor_impl_index_cursor_contains_object(instance, object, xctx)
 Call method contains_object of interface afw_adaptor_impl_index_cursor. More...
 
#define afw_adaptor_impl_index_cursor_inner_join(instance, cursor, xctx)
 Call method inner_join of interface afw_adaptor_impl_index_cursor. More...
 
#define afw_adaptor_impl_index_cursor_get_count(instance, count, xctx)
 Call method get_count of interface afw_adaptor_impl_index_cursor. More...
 

Typedefs

typedef void(* afw_adaptor_impl_index_cursor_release_t) (const afw_adaptor_impl_index_cursor_t *instance, afw_xctx_t *xctx)
 
typedef const afw_object_t *(* afw_adaptor_impl_index_cursor_get_next_object_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_pool_t *pool, afw_xctx_t *xctx)
 
typedef afw_boolean_t(* afw_adaptor_impl_index_cursor_contains_object_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_object_t *object, afw_xctx_t *xctx)
 
typedef const afw_adaptor_impl_index_cursor_t *(* afw_adaptor_impl_index_cursor_inner_join_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_adaptor_impl_index_cursor_t *cursor, afw_xctx_t *xctx)
 
typedef afw_boolean_t(* afw_adaptor_impl_index_cursor_get_count_t) (const afw_adaptor_impl_index_cursor_t *instance, size_t *count, afw_xctx_t *xctx)
 

Detailed Description

Adaptor implementation index cursor interface.

Macro Definition Documentation

◆ afw_adaptor_impl_index_cursor_contains_object

#define afw_adaptor_impl_index_cursor_contains_object (   instance,
  object,
  xctx 
)
Value:
(instance)->inf->contains_object( \
(instance), \
(object), \
(xctx) \
)

Call method contains_object of interface afw_adaptor_impl_index_cursor.

Parameters
instancePointer to this adaptor impl index cursor instance.
objectPointer to object we need to determine is in this cursor.
xctxThis is the caller's xctx.

Definition at line 1033 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_get_count

#define afw_adaptor_impl_index_cursor_get_count (   instance,
  count,
  xctx 
)
Value:
(instance)->inf->get_count( \
(instance), \
(count), \
(xctx) \
)

Call method get_count of interface afw_adaptor_impl_index_cursor.

Parameters
instancePointer to this adaptor impl index cursor instance.
countPointer to the count, where the caller should return the value.
xctxThis is the caller's xctx.

Definition at line 1067 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_get_next_object

#define afw_adaptor_impl_index_cursor_get_next_object (   instance,
  pool,
  xctx 
)
Value:
(instance)->inf->get_next_object( \
(instance), \
(pool), \
(xctx) \
)

Call method get_next_object of interface afw_adaptor_impl_index_cursor.

Parameters
instancePointer to this adaptor impl index cursor instance.
poolMemory pool to allocate resources in.
xctxThis is the caller's xctx.

Definition at line 1015 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_inner_join

#define afw_adaptor_impl_index_cursor_inner_join (   instance,
  cursor,
  xctx 
)
Value:
(instance)->inf->inner_join( \
(instance), \
(cursor), \
(xctx) \
)

Call method inner_join of interface afw_adaptor_impl_index_cursor.

Parameters
instancePointer to this adaptor impl index cursor instance.
cursorPointer to the cursor we need to join with.
xctxThis is the caller's xctx.

Definition at line 1050 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_release

#define afw_adaptor_impl_index_cursor_release (   instance,
  xctx 
)
Value:
(instance)->inf->release( \
(instance), \
(xctx) \
)

Call method release of interface afw_adaptor_impl_index_cursor.

Parameters
instancePointer to this adaptor impl index cursor instance.
xctxThis is the caller's xctx.

Definition at line 999 of file afw_interface.h.

Typedef Documentation

◆ afw_adaptor_impl_index_cursor_contains_object_t

typedef afw_boolean_t(* afw_adaptor_impl_index_cursor_contains_object_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_object_t *object, afw_xctx_t *xctx)

◆ afw_adaptor_impl_index_cursor_get_count_t

typedef afw_boolean_t(* afw_adaptor_impl_index_cursor_get_count_t) (const afw_adaptor_impl_index_cursor_t *instance, size_t *count, afw_xctx_t *xctx)
See also
afw_adaptor_impl_index_cursor_get_count()

Definition at line 978 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_get_next_object_t

typedef const afw_object_t*(* afw_adaptor_impl_index_cursor_get_next_object_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_pool_t *pool, afw_xctx_t *xctx)

◆ afw_adaptor_impl_index_cursor_inner_join_t

typedef const afw_adaptor_impl_index_cursor_t*(* afw_adaptor_impl_index_cursor_inner_join_t) (const afw_adaptor_impl_index_cursor_t *instance, const afw_adaptor_impl_index_cursor_t *cursor, afw_xctx_t *xctx)
See also
afw_adaptor_impl_index_cursor_inner_join()

Definition at line 971 of file afw_interface.h.

◆ afw_adaptor_impl_index_cursor_release_t

typedef void(* afw_adaptor_impl_index_cursor_release_t) (const afw_adaptor_impl_index_cursor_t *instance, afw_xctx_t *xctx)
See also
afw_adaptor_impl_index_cursor_release()

Definition at line 951 of file afw_interface.h.