cgul_list_node_cxx Class Reference

C++ bindings for cgul_list_node More...

#include <cgul_list_node_cxx.h>

Collaboration diagram for cgul_list_node_cxx:
Collaboration graph

Public Member Functions

void * get_value () const
 
void set_value (const void *value)
 
cgul_list_node_cxxget_prev () const
 
cgul_list_node_cxxget_next () const
 
cgul_list_node_t get_obj () const
 

Friends

class cgul_list_cxx
 

Detailed Description

This class provides the C++ bindings for C cgul_list_node objects. The main purpose of this class is to convert the C-style function calls and exception handling in cgul_list_node into C++-style function calls and exception handling. This class must not be extended.

Member Function Documentation

§ get_value()

void* cgul_list_node_cxx::get_value ( ) const
inline

Return the value stored in the node.

Returns
value stored in n

References cgul_list_node__get_value().

§ set_value()

void cgul_list_node_cxx::set_value ( const void *  value)
inline

Set the value to be stored in the node.

Parameters
[in]valuevalue to be stored in the node

References cgul_list_node__set_value().

§ get_prev()

cgul_list_node_cxx* cgul_list_node_cxx::get_prev ( ) const
inline

Return the next node. You can use this method to iterate over the list. When there are no more nodes, NULL is returned. You can use get_back() to get the last node in order to start iterating. A set_prev() exists, but it is private.

Returns
previous node

References cgul_list_node__get_prev().

§ get_next()

cgul_list_node_cxx* cgul_list_node_cxx::get_next ( ) const
inline

Return the previous node. You can use this method to iterate over the list. When there are no more nodes, NULL is returned. You can use get_front() to get the first node in order to start iterating. A set_next() exists, but it is private.

Returns
next node

References cgul_list_node__get_next().

§ get_obj()

cgul_list_node_t cgul_list_node_cxx::get_obj ( ) const
inline

Get the underlying cgul_list_node object.

Returns
underlying object

Friends And Related Function Documentation

§ cgul_list_cxx

friend class cgul_list_cxx
friend

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