Fawkes API
Fawkes Development Version
|
Interface field iterator. More...
#include <>>
Public Member Functions | |
InterfaceFieldIterator () | |
Constructor. More... | |
InterfaceFieldIterator (const InterfaceFieldIterator &fit) | |
Copy constructor. More... | |
~InterfaceFieldIterator () | |
Destructor. More... | |
InterfaceFieldIterator & | operator++ () |
Prefix increment. More... | |
InterfaceFieldIterator | operator++ (int inc) |
Postfix increment operator. More... | |
InterfaceFieldIterator & | operator+ (unsigned int i) |
Advance by i steps. More... | |
InterfaceFieldIterator & | operator+= (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... | |
InterfaceFieldIterator & | operator= (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... | |
std::list< const char * > | get_enum_valuenames () const |
Return the list of possible enum value names. 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... | |
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.
Definition at line 38 of file field_iterator.h.
fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | ) |
fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | const InterfaceFieldIterator & | fit | ) |
fawkes::InterfaceFieldIterator::~InterfaceFieldIterator | ( | ) |
Destructor.
Definition at line 82 of file field_iterator.cpp.
|
protected |
Constructor.
This creates an iterator pointing to the given entry of the info list.
interface | interface this field iterator is assigned to |
info_list | pointer to info list entry to start from |
Definition at line 59 of file field_iterator.cpp.
bool fawkes::InterfaceFieldIterator::get_bool | ( | unsigned int | index = 0 | ) | const |
Get value of current field as bool.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type bool |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 408 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.
bool * fawkes::InterfaceFieldIterator::get_bools | ( | ) | const |
Get value of current field as bool array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type bool or field is not an array (length is 1) |
Definition at line 708 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.
uint8_t fawkes::InterfaceFieldIterator::get_byte | ( | unsigned int | index = 0 | ) | const |
Get value of current field as byte.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type byte |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 639 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.
uint8_t * fawkes::InterfaceFieldIterator::get_bytes | ( | ) | const |
Get value of current field as byte array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type byte or field is not an array (length is 1) |
Definition at line 908 of file field_iterator.cpp.
References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
double fawkes::InterfaceFieldIterator::get_double | ( | unsigned int | index = 0 | ) | const |
Get value of current field as double.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type float |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 618 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.
double * fawkes::InterfaceFieldIterator::get_doubles | ( | ) | const |
Get value of current field as double array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type double or field is not an array (length is 1) |
Definition at line 890 of file field_iterator.cpp.
References fawkes::IFT_DOUBLE, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
int32_t fawkes::InterfaceFieldIterator::get_enum | ( | unsigned int | index = 0 | ) | const |
Get value of current enum field as integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 660 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.
const char * fawkes::InterfaceFieldIterator::get_enum_string | ( | unsigned int | index = 0 | ) | const |
Get value of current enum field as string.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
IllegalArgumentException | thrown if the value is set to an integer which is not represented by any of the canonical enum values |
Definition at line 683 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.
std::list< const char * > fawkes::InterfaceFieldIterator::get_enum_valuenames | ( | ) | const |
Return the list of possible enum value names.
Definition at line 246 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::enum_map.
int32_t * fawkes::InterfaceFieldIterator::get_enums | ( | ) | const |
Get value of current enum field as integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 926 of file field_iterator.cpp.
References fawkes::IFT_ENUM, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
float fawkes::InterfaceFieldIterator::get_float | ( | unsigned int | index = 0 | ) | const |
Get value of current field as float.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type float |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 597 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.
float * fawkes::InterfaceFieldIterator::get_floats | ( | ) | const |
Get value of current field as float array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type float or field is not an array (length is 1) |
Definition at line 872 of file field_iterator.cpp.
References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
int16_t fawkes::InterfaceFieldIterator::get_int16 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 471 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.
int16_t * fawkes::InterfaceFieldIterator::get_int16s | ( | ) | const |
Get value of current field as integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 764 of file field_iterator.cpp.
References fawkes::IFT_INT16, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
int32_t fawkes::InterfaceFieldIterator::get_int32 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 513 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.
int32_t * fawkes::InterfaceFieldIterator::get_int32s | ( | ) | const |
Get value of current field as integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 800 of file field_iterator.cpp.
References fawkes::IFT_INT32, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
int64_t fawkes::InterfaceFieldIterator::get_int64 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 555 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.
int64_t * fawkes::InterfaceFieldIterator::get_int64s | ( | ) | const |
Get value of current field as integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 836 of file field_iterator.cpp.
References fawkes::IFT_INT64, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
int8_t fawkes::InterfaceFieldIterator::get_int8 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 429 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.
int8_t * fawkes::InterfaceFieldIterator::get_int8s | ( | ) | const |
Get value of current field as integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 728 of file field_iterator.cpp.
References fawkes::IFT_INT8, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
size_t fawkes::InterfaceFieldIterator::get_length | ( | ) | const |
Get length of current field.
Definition at line 286 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::length.
const char * fawkes::InterfaceFieldIterator::get_name | ( | void | ) | const |
Get name of current field.
Definition at line 260 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::name.
const char * fawkes::InterfaceFieldIterator::get_string | ( | ) | const |
Get value of current field as string.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type string |
Definition at line 943 of file field_iterator.cpp.
References fawkes::IFT_STRING, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
interface_fieldtype_t fawkes::InterfaceFieldIterator::get_type | ( | ) | const |
Get type of current field.
Definition at line 191 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::type.
const char * fawkes::InterfaceFieldIterator::get_typename | ( | ) | const |
Get type of current field as string.
Definition at line 204 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::enumtype, fawkes::IFT_BOOL, fawkes::IFT_BYTE, fawkes::IFT_DOUBLE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::IFT_INT16, fawkes::IFT_INT32, fawkes::IFT_INT64, fawkes::IFT_INT8, fawkes::IFT_STRING, fawkes::IFT_UINT16, fawkes::IFT_UINT32, fawkes::IFT_UINT64, fawkes::IFT_UINT8, and fawkes::interface_fieldinfo_t::type.
uint16_t fawkes::InterfaceFieldIterator::get_uint16 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as unsigned integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 492 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.
uint16_t * fawkes::InterfaceFieldIterator::get_uint16s | ( | ) | const |
Get value of current field as unsigned integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 782 of file field_iterator.cpp.
References fawkes::IFT_UINT16, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
uint32_t fawkes::InterfaceFieldIterator::get_uint32 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as unsigned integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 534 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.
uint32_t * fawkes::InterfaceFieldIterator::get_uint32s | ( | ) | const |
Get value of current field as unsigned integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 818 of file field_iterator.cpp.
References fawkes::IFT_UINT32, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
uint64_t fawkes::InterfaceFieldIterator::get_uint64 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as unsigned integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 576 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.
uint64_t * fawkes::InterfaceFieldIterator::get_uint64s | ( | ) | const |
Get value of current field as unsigned integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 854 of file field_iterator.cpp.
References fawkes::IFT_UINT64, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
uint8_t fawkes::InterfaceFieldIterator::get_uint8 | ( | unsigned int | index = 0 | ) | const |
Get value of current field as unsigned integer.
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 450 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.
uint8_t * fawkes::InterfaceFieldIterator::get_uint8s | ( | ) | const |
Get value of current field as unsigned integer array.
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 746 of file field_iterator.cpp.
References fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
const void * fawkes::InterfaceFieldIterator::get_value | ( | ) | const |
Get value of current field.
Definition at line 273 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::value.
const char * fawkes::InterfaceFieldIterator::get_value_string | ( | const char * | array_sep = ", " | ) |
Get value of current field as string.
array_sep | in the case that the field is an array the given string is used to split the individual elements in the array string representation |
Definition at line 301 of file field_iterator.cpp.
References fawkes::Interface::enum_tostring(), fawkes::interface_fieldinfo_t::enumtype, fawkes::IFT_BOOL, fawkes::IFT_BYTE, fawkes::IFT_DOUBLE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::IFT_INT16, fawkes::IFT_INT32, fawkes::IFT_INT64, fawkes::IFT_INT8, fawkes::IFT_STRING, fawkes::IFT_UINT16, fawkes::IFT_UINT32, fawkes::IFT_UINT64, fawkes::IFT_UINT8, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
bool fawkes::InterfaceFieldIterator::is_enum | ( | ) | const |
Check if field is an enum.
Definition at line 233 of file field_iterator.cpp.
References fawkes::IFT_ENUM, and fawkes::interface_fieldinfo_t::type.
bool fawkes::InterfaceFieldIterator::operator!= | ( | const InterfaceFieldIterator & | fi | ) | const |
Check iterators for inequality.
fi | iterator to compare to |
Definition at line 157 of file field_iterator.cpp.
const void * fawkes::InterfaceFieldIterator::operator* | ( | ) | const |
Get FieldHeader.
Definition at line 165 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::value.
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+ | ( | unsigned int | i | ) |
Advance by i steps.
i | number of (matching) segments to advance. |
Definition at line 121 of file field_iterator.cpp.
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator++ | ( | ) |
Prefix increment.
Definition at line 92 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::next.
InterfaceFieldIterator fawkes::InterfaceFieldIterator::operator++ | ( | int | inc | ) |
Postfix increment operator.
inc | ignored |
Definition at line 109 of file field_iterator.cpp.
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+= | ( | unsigned int | i | ) |
Advance by i steps.
i | number of (matching) segments to advance. |
Definition at line 134 of file field_iterator.cpp.
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator= | ( | const InterfaceFieldIterator & | fi | ) |
Make this instance point to the same segment as fi.
fi | field iterator to compare |
Definition at line 179 of file field_iterator.cpp.
bool fawkes::InterfaceFieldIterator::operator== | ( | const InterfaceFieldIterator & | fi | ) | const |
Check iterators for equality.
fi | iterator to compare to |
Definition at line 147 of file field_iterator.cpp.
void fawkes::InterfaceFieldIterator::set_bool | ( | bool | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as bool.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type bool |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 962 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.
void fawkes::InterfaceFieldIterator::set_bools | ( | bool * | v | ) |
Set value of current field as bool array.
v | an array of bools |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type bool or field is not an array (length is 1) |
Definition at line 1309 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.
void fawkes::InterfaceFieldIterator::set_byte | ( | uint8_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as byte.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type byte |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1226 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.
void fawkes::InterfaceFieldIterator::set_bytes | ( | uint8_t * | v | ) |
Set value of current field as byte array.
v | an array of bytes |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type byte or field is not an array (length is 1) |
Definition at line 1551 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.
void fawkes::InterfaceFieldIterator::set_double | ( | double | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as double.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type double |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1202 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.
void fawkes::InterfaceFieldIterator::set_doubles | ( | double * | v | ) |
Set value of current field as double array.
v | an array of doubles |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type double or field is not an array (length is 1) |
Definition at line 1529 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.
void fawkes::InterfaceFieldIterator::set_enum | ( | int32_t | e, |
unsigned int | index = 0 |
||
) |
Set value of current field as enum (from an integer).
e | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1250 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.
void fawkes::InterfaceFieldIterator::set_enum_string | ( | const char * | e, |
unsigned int | index = 0 |
||
) |
Set value of current field as enum (from an integer).
e | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1278 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.
void fawkes::InterfaceFieldIterator::set_float | ( | float | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as float.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type float |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1178 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.
void fawkes::InterfaceFieldIterator::set_floats | ( | float * | v | ) |
Set value of current field as float array.
v | an array of floats |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type float or field is not an array (length is 1) |
Definition at line 1507 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.
void fawkes::InterfaceFieldIterator::set_int16 | ( | int16_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1034 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.
void fawkes::InterfaceFieldIterator::set_int16s | ( | int16_t * | v | ) |
Set value of current field as integer array.
v | an array of ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 1375 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.
void fawkes::InterfaceFieldIterator::set_int32 | ( | int32_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1082 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.
void fawkes::InterfaceFieldIterator::set_int32s | ( | int32_t * | v | ) |
Set value of current field as integer array.
v | an array of ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 1419 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.
void fawkes::InterfaceFieldIterator::set_int64 | ( | int64_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1130 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.
void fawkes::InterfaceFieldIterator::set_int64s | ( | int64_t * | v | ) |
Set value of current field as integer array.
v | an array of ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 1463 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.
void fawkes::InterfaceFieldIterator::set_int8 | ( | int8_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 986 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.
void fawkes::InterfaceFieldIterator::set_int8s | ( | int8_t * | v | ) |
Set value of current field as integer array.
v | an array of ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type int or field is not an array (length is 1) |
Definition at line 1331 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.
void fawkes::InterfaceFieldIterator::set_string | ( | const char * | v | ) |
Set value of current field as string.
v | a string |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type string |
Definition at line 1572 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.
void fawkes::InterfaceFieldIterator::set_uint16 | ( | uint16_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as unsigned integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1058 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.
void fawkes::InterfaceFieldIterator::set_uint16s | ( | uint16_t * | v | ) |
Set value of current field as unsigned integer array.
v | an array of unsigned ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 1397 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.
void fawkes::InterfaceFieldIterator::set_uint32 | ( | uint32_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as unsigned integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1106 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.
void fawkes::InterfaceFieldIterator::set_uint32s | ( | uint32_t * | v | ) |
Set value of current field as unsigned integer array.
v | an array of unsigned ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 1441 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.
void fawkes::InterfaceFieldIterator::set_uint64 | ( | uint64_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as unsigned integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1154 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.
void fawkes::InterfaceFieldIterator::set_uint64s | ( | uint64_t * | v | ) |
Set value of current field as unsigned integer array.
v | an array of unsigned ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 1485 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.
void fawkes::InterfaceFieldIterator::set_uint8 | ( | uint8_t | v, |
unsigned int | index = 0 |
||
) |
Set value of current field as unsigned integer.
v | the new value |
index | array index (only use if field is an array) |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int |
OutOfBoundsException | thrown if index is out of bounds |
Definition at line 1010 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.
void fawkes::InterfaceFieldIterator::set_uint8s | ( | uint8_t * | v | ) |
Set value of current field as unsigned integer array.
v | an array of unsigned ints |
NullPointerException | invalid iterator, possibly end iterator |
TypeMismatchException | thrown if field is not of type unsigned int or field is not an array (length is 1) |
Definition at line 1353 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.