Fawkes API  Fawkes Development Version
fawkes::InterfaceFieldIterator Class Reference

Interface field iterator. More...

#include <>>

Public Member Functions

 InterfaceFieldIterator ()
 Constructor. More...
 
 InterfaceFieldIterator (const InterfaceFieldIterator &fit)
 Copy constructor. More...
 
 ~InterfaceFieldIterator ()
 Destructor. More...
 
InterfaceFieldIteratoroperator++ ()
 Prefix increment. More...
 
InterfaceFieldIterator operator++ (int inc)
 Postfix increment operator. More...
 
InterfaceFieldIteratoroperator+ (unsigned int i)
 Advance by i steps. More...
 
InterfaceFieldIteratoroperator+= (unsigned int i)
 Advance by i steps. More...
 
bool operator== (const InterfaceFieldIterator &fit) const
 Check iterators for equality. More...
 
bool operator!= (const InterfaceFieldIterator &fit) const
 Check iterators for inequality. More...
 
const void * operator* () const
 Get FieldHeader. More...
 
InterfaceFieldIteratoroperator= (const InterfaceFieldIterator &fit)
 Make this instance point to the same segment as fi. More...
 
interface_fieldtype_t get_type () const
 Get type of current field. More...
 
const char * get_typename () const
 Get type of current field as string. More...
 
bool is_enum () const
 Check if field is an enum. More...
 
const char * get_name () const
 Get name of current field. More...
 
const void * get_value () const
 Get value of current field. More...
 
const char * get_value_string (const char *array_sep=", ")
 Get value of current field as string. More...
 
size_t get_length () const
 Get length of current field. More...
 
bool get_bool (unsigned int index=0) const
 Get value of current field as bool. More...
 
int8_t get_int8 (unsigned int index=0) const
 Get value of current field as integer. More...
 
uint8_t get_uint8 (unsigned int index=0) const
 Get value of current field as unsigned integer. More...
 
int16_t get_int16 (unsigned int index=0) const
 Get value of current field as integer. More...
 
uint16_t get_uint16 (unsigned int index=0) const
 Get value of current field as unsigned integer. More...
 
int32_t get_int32 (unsigned int index=0) const
 Get value of current field as integer. More...
 
uint32_t get_uint32 (unsigned int index=0) const
 Get value of current field as unsigned integer. More...
 
int64_t get_int64 (unsigned int index=0) const
 Get value of current field as integer. More...
 
uint64_t get_uint64 (unsigned int index=0) const
 Get value of current field as unsigned integer. More...
 
float get_float (unsigned int index=0) const
 Get value of current field as float. More...
 
double get_double (unsigned int index=0) const
 Get value of current field as double. More...
 
uint8_t get_byte (unsigned int index=0) const
 Get value of current field as byte. More...
 
int32_t get_enum (unsigned int index=0) const
 Get value of current enum field as integer. More...
 
const char * get_enum_string (unsigned int index=0) const
 Get value of current enum field as string. More...
 
bool * get_bools () const
 Get value of current field as bool array. More...
 
int8_t * get_int8s () const
 Get value of current field as integer array. More...
 
uint8_t * get_uint8s () const
 Get value of current field as unsigned integer array. More...
 
int16_t * get_int16s () const
 Get value of current field as integer array. More...
 
uint16_t * get_uint16s () const
 Get value of current field as unsigned integer array. More...
 
int32_t * get_int32s () const
 Get value of current field as integer array. More...
 
uint32_t * get_uint32s () const
 Get value of current field as unsigned integer array. More...
 
int64_t * get_int64s () const
 Get value of current field as integer array. More...
 
uint64_t * get_uint64s () const
 Get value of current field as unsigned integer array. More...
 
float * get_floats () const
 Get value of current field as float array. More...
 
double * get_doubles () const
 Get value of current field as double array. More...
 
uint8_t * get_bytes () const
 Get value of current field as byte array. More...
 
int32_t * get_enums () const
 Get value of current enum field as integer array. More...
 
const char * get_string () const
 Get value of current field as string. More...
 
void set_bool (bool b, unsigned int index=0)
 Set value of current field as bool. More...
 
void set_int8 (int8_t i, unsigned int index=0)
 Set value of current field as integer. More...
 
void set_uint8 (uint8_t i, unsigned int index=0)
 Set value of current field as unsigned integer. More...
 
void set_int16 (int16_t i, unsigned int index=0)
 Set value of current field as integer. More...
 
void set_uint16 (uint16_t i, unsigned int index=0)
 Set value of current field as unsigned integer. More...
 
void set_int32 (int32_t i, unsigned int index=0)
 Set value of current field as integer. More...
 
void set_uint32 (uint32_t i, unsigned int index=0)
 Set value of current field as unsigned integer. More...
 
void set_int64 (int64_t i, unsigned int index=0)
 Set value of current field as integer. More...
 
void set_uint64 (uint64_t i, unsigned int index=0)
 Set value of current field as unsigned integer. More...
 
void set_float (float f, unsigned int index=0)
 Set value of current field as float. More...
 
void set_double (double f, unsigned int index=0)
 Set value of current field as double. More...
 
void set_byte (uint8_t b, unsigned int index=0)
 Set value of current field as byte. More...
 
void set_enum (int32_t e, unsigned int index=0)
 Set value of current field as enum (from an integer). More...
 
void set_enum_string (const char *e, unsigned int index=0)
 Set value of current field as enum (from an integer). More...
 
void set_bools (bool *b)
 Set value of current field as bool array. More...
 
void set_int8s (int8_t *i)
 Set value of current field as integer array. More...
 
void set_uint8s (uint8_t *i)
 Set value of current field as unsigned integer array. More...
 
void set_int16s (int16_t *i)
 Set value of current field as integer array. More...
 
void set_uint16s (uint16_t *i)
 Set value of current field as unsigned integer array. More...
 
void set_int32s (int32_t *i)
 Set value of current field as integer array. More...
 
void set_uint32s (uint32_t *i)
 Set value of current field as unsigned integer array. More...
 
void set_int64s (int64_t *i)
 Set value of current field as integer array. More...
 
void set_uint64s (uint64_t *i)
 Set value of current field as unsigned integer array. More...
 
void set_floats (float *f)
 Set value of current field as float array. More...
 
void set_doubles (double *f)
 Set value of current field as double array. More...
 
void set_bytes (uint8_t *b)
 Set value of current field as byte array. More...
 
void set_string (const char *s)
 Set value of current field as string. More...
 

Protected Member Functions

 InterfaceFieldIterator (Interface *interface, const interface_fieldinfo_t *info_list)
 Constructor. More...
 

Friends

class Interface
 
class Message
 

Detailed Description

Interface field iterator.

This iterator is part of the BlackBoard introspection API. It can be used to iterate over all available fields and values of an interface without actually knowing the specific type of the interface.

Author
Tim Niemueller

Definition at line 37 of file field_iterator.h.

Constructor & Destructor Documentation

◆ InterfaceFieldIterator() [1/3]

fawkes::InterfaceFieldIterator::InterfaceFieldIterator ( )

Constructor.

Creates an invalid iterator.

Definition at line 49 of file field_iterator.cpp.

◆ InterfaceFieldIterator() [2/3]

fawkes::InterfaceFieldIterator::InterfaceFieldIterator ( const InterfaceFieldIterator fit)

Copy constructor.

Parameters
fititerator to copy

Definition at line 74 of file field_iterator.cpp.

◆ ~InterfaceFieldIterator()

fawkes::InterfaceFieldIterator::~InterfaceFieldIterator ( )

Destructor.

Definition at line 87 of file field_iterator.cpp.

◆ InterfaceFieldIterator() [3/3]

fawkes::InterfaceFieldIterator::InterfaceFieldIterator ( Interface interface,
const interface_fieldinfo_t info_list 
)
protected

Constructor.

This creates an iterator pointing to the given entry of the info list.

Parameters
interfaceinterface this field iterator is assigned to
info_listpointer to info list entry to start from

Definition at line 62 of file field_iterator.cpp.

Member Function Documentation

◆ get_bool()

bool fawkes::InterfaceFieldIterator::get_bool ( unsigned int  index = 0) const

Get value of current field as bool.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type bool
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 416 of file field_iterator.cpp.

References fawkes::IFT_BOOL, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_bools()

bool * fawkes::InterfaceFieldIterator::get_bools ( ) const

Get value of current field as bool array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type bool or field is not an array (length is 1)

Definition at line 726 of file field_iterator.cpp.

References fawkes::IFT_BOOL, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_byte()

uint8_t fawkes::InterfaceFieldIterator::get_byte ( unsigned int  index = 0) const

Get value of current field as byte.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type byte
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 655 of file field_iterator.cpp.

References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_bytes()

uint8_t * fawkes::InterfaceFieldIterator::get_bytes ( ) const

Get value of current field as byte array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type byte or field is not an array (length is 1)

Definition at line 937 of file field_iterator.cpp.

References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_double()

double fawkes::InterfaceFieldIterator::get_double ( unsigned int  index = 0) const

Get value of current field as double.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type float
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 633 of file field_iterator.cpp.

References fawkes::IFT_DOUBLE, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_doubles()

double * fawkes::InterfaceFieldIterator::get_doubles ( ) const

Get value of current field as double array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type double or field is not an array (length is 1)

Definition at line 918 of file field_iterator.cpp.

References fawkes::IFT_DOUBLE, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_enum()

int32_t fawkes::InterfaceFieldIterator::get_enum ( unsigned int  index = 0) const

Get value of current enum field as integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 677 of file field_iterator.cpp.

References fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_enum_string()

const char * fawkes::InterfaceFieldIterator::get_enum_string ( unsigned int  index = 0) const

Get value of current enum field as string.

Returns
field value as string
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds
IllegalArgumentExceptionthrown if the value is set to an integer which is not represented by any of the canonical enum values

Definition at line 701 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::enum_map, fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ get_enums()

int32_t * fawkes::InterfaceFieldIterator::get_enums ( ) const

Get value of current enum field as integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 956 of file field_iterator.cpp.

References fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_float()

float fawkes::InterfaceFieldIterator::get_float ( unsigned int  index = 0) const

Get value of current field as float.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type float
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 611 of file field_iterator.cpp.

References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_floats()

float * fawkes::InterfaceFieldIterator::get_floats ( ) const

Get value of current field as float array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type float or field is not an array (length is 1)

Definition at line 899 of file field_iterator.cpp.

References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_int16()

int16_t fawkes::InterfaceFieldIterator::get_int16 ( unsigned int  index = 0) const

Get value of current field as integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 481 of file field_iterator.cpp.

References fawkes::IFT_INT16, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_int16s()

int16_t * fawkes::InterfaceFieldIterator::get_int16s ( ) const

Get value of current field as integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 785 of file field_iterator.cpp.

References fawkes::IFT_INT16, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_int32()

int32_t fawkes::InterfaceFieldIterator::get_int32 ( unsigned int  index = 0) const

Get value of current field as integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 524 of file field_iterator.cpp.

References fawkes::IFT_INT32, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_int32s()

int32_t * fawkes::InterfaceFieldIterator::get_int32s ( ) const

Get value of current field as integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 823 of file field_iterator.cpp.

References fawkes::IFT_INT32, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_int64()

int64_t fawkes::InterfaceFieldIterator::get_int64 ( unsigned int  index = 0) const

Get value of current field as integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 567 of file field_iterator.cpp.

References fawkes::IFT_INT64, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_int64s()

int64_t * fawkes::InterfaceFieldIterator::get_int64s ( ) const

Get value of current field as integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 861 of file field_iterator.cpp.

References fawkes::IFT_INT64, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_int8()

int8_t fawkes::InterfaceFieldIterator::get_int8 ( unsigned int  index = 0) const

Get value of current field as integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 438 of file field_iterator.cpp.

References fawkes::IFT_INT8, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_int8s()

int8_t * fawkes::InterfaceFieldIterator::get_int8s ( ) const

Get value of current field as integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 747 of file field_iterator.cpp.

References fawkes::IFT_INT8, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_length()

size_t fawkes::InterfaceFieldIterator::get_length ( ) const

◆ get_name()

const char * fawkes::InterfaceFieldIterator::get_name ( void  ) const

◆ get_string()

const char * fawkes::InterfaceFieldIterator::get_string ( ) const

Get value of current field as string.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type string

Definition at line 974 of file field_iterator.cpp.

References fawkes::IFT_STRING, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_type()

interface_fieldtype_t fawkes::InterfaceFieldIterator::get_type ( ) const

◆ get_typename()

◆ get_uint16()

uint16_t fawkes::InterfaceFieldIterator::get_uint16 ( unsigned int  index = 0) const

Get value of current field as unsigned integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 503 of file field_iterator.cpp.

References fawkes::IFT_UINT16, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_uint16s()

uint16_t * fawkes::InterfaceFieldIterator::get_uint16s ( ) const

Get value of current field as unsigned integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 804 of file field_iterator.cpp.

References fawkes::IFT_UINT16, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_uint32()

uint32_t fawkes::InterfaceFieldIterator::get_uint32 ( unsigned int  index = 0) const

Get value of current field as unsigned integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 546 of file field_iterator.cpp.

References fawkes::IFT_UINT32, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_uint32s()

uint32_t * fawkes::InterfaceFieldIterator::get_uint32s ( ) const

Get value of current field as unsigned integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 842 of file field_iterator.cpp.

References fawkes::IFT_UINT32, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_uint64()

uint64_t fawkes::InterfaceFieldIterator::get_uint64 ( unsigned int  index = 0) const

Get value of current field as unsigned integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 589 of file field_iterator.cpp.

References fawkes::IFT_UINT64, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_uint64s()

uint64_t * fawkes::InterfaceFieldIterator::get_uint64s ( ) const

Get value of current field as unsigned integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 880 of file field_iterator.cpp.

References fawkes::IFT_UINT64, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_uint8()

uint8_t fawkes::InterfaceFieldIterator::get_uint8 ( unsigned int  index = 0) const

Get value of current field as unsigned integer.

Returns
field value
Parameters
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 460 of file field_iterator.cpp.

References fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created(), and fawkes::EclExternalBlackBoard::interfaces().

◆ get_uint8s()

uint8_t * fawkes::InterfaceFieldIterator::get_uint8s ( ) const

Get value of current field as unsigned integer array.

Returns
field value
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 766 of file field_iterator.cpp.

References fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by MongoLogBlackboardThread::bb_interface_created().

◆ get_value()

const void * fawkes::InterfaceFieldIterator::get_value ( ) const

Get value of current field.

Returns
field value

Definition at line 276 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::value.

◆ get_value_string()

const char * fawkes::InterfaceFieldIterator::get_value_string ( const char *  array_sep = ", ")

◆ is_enum()

bool fawkes::InterfaceFieldIterator::is_enum ( ) const

Check if field is an enum.

Returns
true if the value is an enum, false otherwise

Definition at line 248 of file field_iterator.cpp.

References fawkes::IFT_ENUM, and fawkes::interface_fieldinfo_t::type.

◆ operator!=()

bool fawkes::InterfaceFieldIterator::operator!= ( const InterfaceFieldIterator fi) const

Check iterators for inequality.

Parameters
fiiterator to compare to
Returns
true if iteraters point to the different fields, false otherwise

Definition at line 166 of file field_iterator.cpp.

◆ operator*()

const void * fawkes::InterfaceFieldIterator::operator* ( ) const

Get FieldHeader.

Returns
shared memory header

Definition at line 176 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::value.

◆ operator+()

InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+ ( unsigned int  i)

Advance by i steps.

Parameters
inumber of (matching) segments to advance.
Returns
reference to this after advancing

Definition at line 127 of file field_iterator.cpp.

◆ operator++() [1/2]

InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator++ ( )

Prefix increment.

Returns
reference to this instance

Definition at line 97 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::next.

◆ operator++() [2/2]

InterfaceFieldIterator fawkes::InterfaceFieldIterator::operator++ ( int  inc)

Postfix increment operator.

Parameters
incignored
Returns
instance before advancing to the next shared memory segment

Definition at line 114 of file field_iterator.cpp.

◆ operator+=()

InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+= ( unsigned int  i)

Advance by i steps.

Parameters
inumber of (matching) segments to advance.
Returns
reference to this after advancing

Definition at line 141 of file field_iterator.cpp.

◆ operator=()

InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator= ( const InterfaceFieldIterator fi)

Make this instance point to the same segment as fi.

Parameters
fifield iterator to compare
Returns
reference to this instance

Definition at line 191 of file field_iterator.cpp.

◆ operator==()

bool fawkes::InterfaceFieldIterator::operator== ( const InterfaceFieldIterator fi) const

Check iterators for equality.

Parameters
fiiterator to compare to
Returns
true if iterators point to the the same field, false otherwise

Definition at line 155 of file field_iterator.cpp.

◆ set_bool()

void fawkes::InterfaceFieldIterator::set_bool ( bool  v,
unsigned int  index = 0 
)

Set value of current field as bool.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type bool
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 994 of file field_iterator.cpp.

References fawkes::IFT_BOOL, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_bools()

void fawkes::InterfaceFieldIterator::set_bools ( bool *  v)

Set value of current field as bool array.

Parameters
van array of bools
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type bool or field is not an array (length is 1)

Definition at line 1340 of file field_iterator.cpp.

References fawkes::IFT_BOOL, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_byte()

void fawkes::InterfaceFieldIterator::set_byte ( uint8_t  v,
unsigned int  index = 0 
)

Set value of current field as byte.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type byte
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1258 of file field_iterator.cpp.

References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_bytes()

void fawkes::InterfaceFieldIterator::set_bytes ( uint8_t *  v)

Set value of current field as byte array.

Parameters
van array of bytes
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type byte or field is not an array (length is 1)

Definition at line 1581 of file field_iterator.cpp.

References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_double()

void fawkes::InterfaceFieldIterator::set_double ( double  v,
unsigned int  index = 0 
)

Set value of current field as double.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type double
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1234 of file field_iterator.cpp.

References fawkes::IFT_DOUBLE, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed().

◆ set_doubles()

void fawkes::InterfaceFieldIterator::set_doubles ( double *  v)

Set value of current field as double array.

Parameters
van array of doubles
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type double or field is not an array (length is 1)

Definition at line 1559 of file field_iterator.cpp.

References fawkes::IFT_DOUBLE, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_enum()

void fawkes::InterfaceFieldIterator::set_enum ( int32_t  e,
unsigned int  index = 0 
)

Set value of current field as enum (from an integer).

Parameters
ethe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1281 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::enum_map, fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_enum_string()

void fawkes::InterfaceFieldIterator::set_enum_string ( const char *  e,
unsigned int  index = 0 
)

Set value of current field as enum (from an integer).

Parameters
ethe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1309 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::enum_map, fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed().

◆ set_float()

void fawkes::InterfaceFieldIterator::set_float ( float  v,
unsigned int  index = 0 
)

Set value of current field as float.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type float
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1210 of file field_iterator.cpp.

References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_floats()

void fawkes::InterfaceFieldIterator::set_floats ( float *  v)

Set value of current field as float array.

Parameters
van array of floats
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type float or field is not an array (length is 1)

Definition at line 1538 of file field_iterator.cpp.

References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_int16()

void fawkes::InterfaceFieldIterator::set_int16 ( int16_t  v,
unsigned int  index = 0 
)

Set value of current field as integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1066 of file field_iterator.cpp.

References fawkes::IFT_INT16, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_int16s()

void fawkes::InterfaceFieldIterator::set_int16s ( int16_t *  v)

Set value of current field as integer array.

Parameters
van array of ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 1406 of file field_iterator.cpp.

References fawkes::IFT_INT16, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_int32()

void fawkes::InterfaceFieldIterator::set_int32 ( int32_t  v,
unsigned int  index = 0 
)

Set value of current field as integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1114 of file field_iterator.cpp.

References fawkes::IFT_INT32, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_int32s()

void fawkes::InterfaceFieldIterator::set_int32s ( int32_t *  v)

Set value of current field as integer array.

Parameters
van array of ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 1450 of file field_iterator.cpp.

References fawkes::IFT_INT32, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_int64()

void fawkes::InterfaceFieldIterator::set_int64 ( int64_t  v,
unsigned int  index = 0 
)

Set value of current field as integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1162 of file field_iterator.cpp.

References fawkes::IFT_INT64, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_int64s()

void fawkes::InterfaceFieldIterator::set_int64s ( int64_t *  v)

Set value of current field as integer array.

Parameters
van array of ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 1494 of file field_iterator.cpp.

References fawkes::IFT_INT64, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_int8()

void fawkes::InterfaceFieldIterator::set_int8 ( int8_t  v,
unsigned int  index = 0 
)

Set value of current field as integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1018 of file field_iterator.cpp.

References fawkes::IFT_INT8, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_int8s()

void fawkes::InterfaceFieldIterator::set_int8s ( int8_t *  v)

Set value of current field as integer array.

Parameters
van array of ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type int or field is not an array (length is 1)

Definition at line 1362 of file field_iterator.cpp.

References fawkes::IFT_INT8, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_string()

void fawkes::InterfaceFieldIterator::set_string ( const char *  v)

Set value of current field as string.

Parameters
va string
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type string

Definition at line 1602 of file field_iterator.cpp.

References fawkes::IFT_STRING, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_uint16()

void fawkes::InterfaceFieldIterator::set_uint16 ( uint16_t  v,
unsigned int  index = 0 
)

Set value of current field as unsigned integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1090 of file field_iterator.cpp.

References fawkes::IFT_UINT16, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_uint16s()

void fawkes::InterfaceFieldIterator::set_uint16s ( uint16_t *  v)

Set value of current field as unsigned integer array.

Parameters
van array of unsigned ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 1428 of file field_iterator.cpp.

References fawkes::IFT_UINT16, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_uint32()

void fawkes::InterfaceFieldIterator::set_uint32 ( uint32_t  v,
unsigned int  index = 0 
)

Set value of current field as unsigned integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1138 of file field_iterator.cpp.

References fawkes::IFT_UINT32, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_uint32s()

void fawkes::InterfaceFieldIterator::set_uint32s ( uint32_t *  v)

Set value of current field as unsigned integer array.

Parameters
van array of unsigned ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 1472 of file field_iterator.cpp.

References fawkes::IFT_UINT32, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_uint64()

void fawkes::InterfaceFieldIterator::set_uint64 ( uint64_t  v,
unsigned int  index = 0 
)

Set value of current field as unsigned integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1186 of file field_iterator.cpp.

References fawkes::IFT_UINT64, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_uint64s()

void fawkes::InterfaceFieldIterator::set_uint64s ( uint64_t *  v)

Set value of current field as unsigned integer array.

Parameters
van array of unsigned ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 1516 of file field_iterator.cpp.

References fawkes::IFT_UINT64, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

◆ set_uint8()

void fawkes::InterfaceFieldIterator::set_uint8 ( uint8_t  v,
unsigned int  index = 0 
)

Set value of current field as unsigned integer.

Parameters
vthe new value
indexarray index (only use if field is an array)
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int
OutOfBoundsExceptionthrown if index is out of bounds

Definition at line 1042 of file field_iterator.cpp.

References fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.

Referenced by BlackboardCLIPSFeature::clips_context_destroyed(), and fawkes::EclExternalBlackBoard::interfaces().

◆ set_uint8s()

void fawkes::InterfaceFieldIterator::set_uint8s ( uint8_t *  v)

Set value of current field as unsigned integer array.

Parameters
van array of unsigned ints
Exceptions
NullPointerExceptioninvalid iterator, possibly end iterator
TypeMismatchExceptionthrown if field is not of type unsigned int or field is not an array (length is 1)

Definition at line 1384 of file field_iterator.cpp.

References fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::length, fawkes::Interface::mark_data_changed(), fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.


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