Fawkes API
Fawkes Development Version
|
#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 37 of file field_iterator.h.
fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | ) |
fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | const InterfaceFieldIterator & | fit | ) |
fawkes::InterfaceFieldIterator::~InterfaceFieldIterator | ( | ) |
Destructor.
Definition at line 87 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::next.
|
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 64 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 413 of file field_iterator.cpp.
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 713 of file field_iterator.cpp.
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 644 of file field_iterator.cpp.
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 913 of file field_iterator.cpp.
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 623 of file field_iterator.cpp.
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 895 of file field_iterator.cpp.
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 665 of file field_iterator.cpp.
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 688 of file field_iterator.cpp.
std::list< const char * > fawkes::InterfaceFieldIterator::get_enum_valuenames | ( | ) | const |
Return the list of possible enum value names.
Definition at line 251 of file field_iterator.cpp.
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 931 of file field_iterator.cpp.
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 602 of file field_iterator.cpp.
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 877 of file field_iterator.cpp.
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 476 of file field_iterator.cpp.
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 769 of file field_iterator.cpp.
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 518 of file field_iterator.cpp.
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 805 of file field_iterator.cpp.
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 560 of file field_iterator.cpp.
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 841 of file field_iterator.cpp.
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 434 of file field_iterator.cpp.
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 733 of file field_iterator.cpp.
size_t fawkes::InterfaceFieldIterator::get_length | ( | ) | const |
Get length of current field.
Definition at line 291 of file field_iterator.cpp.
const char * fawkes::InterfaceFieldIterator::get_name | ( | void | ) | const |
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 948 of file field_iterator.cpp.
interface_fieldtype_t fawkes::InterfaceFieldIterator::get_type | ( | ) | const |
const char * fawkes::InterfaceFieldIterator::get_typename | ( | ) | const |
Get type of current field as string.
Definition at line 209 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, and fawkes::IFT_UINT8.
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 497 of file field_iterator.cpp.
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 787 of file field_iterator.cpp.
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 539 of file field_iterator.cpp.
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 823 of file field_iterator.cpp.
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 581 of file field_iterator.cpp.
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 859 of file field_iterator.cpp.
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 455 of file field_iterator.cpp.
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 751 of file field_iterator.cpp.
const void * fawkes::InterfaceFieldIterator::get_value | ( | ) | const |
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 306 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 238 of file field_iterator.cpp.
bool fawkes::InterfaceFieldIterator::operator!= | ( | const InterfaceFieldIterator & | fi | ) | const |
Check iterators for inequality.
fi | iterator to compare to |
Definition at line 162 of file field_iterator.cpp.
const void * fawkes::InterfaceFieldIterator::operator* | ( | ) | const |
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+ | ( | unsigned int | i | ) |
Advance by i steps.
i | number of (matching) segments to advance. |
Definition at line 126 of file field_iterator.cpp.
InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator++ | ( | ) |
Prefix increment.
Definition at line 97 of file field_iterator.cpp.
InterfaceFieldIterator fawkes::InterfaceFieldIterator::operator++ | ( | int | inc | ) |
Postfix increment operator.
inc | ignored |
Definition at line 114 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 139 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 184 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 152 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 967 of file field_iterator.cpp.
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 1314 of file field_iterator.cpp.
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 1231 of file field_iterator.cpp.
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 1556 of file field_iterator.cpp.
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 1207 of file field_iterator.cpp.
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 1534 of file field_iterator.cpp.
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 1255 of file field_iterator.cpp.
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 1283 of file field_iterator.cpp.
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 1183 of file field_iterator.cpp.
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 1512 of file field_iterator.cpp.
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 1039 of file field_iterator.cpp.
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 1380 of file field_iterator.cpp.
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 1087 of file field_iterator.cpp.
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 1424 of file field_iterator.cpp.
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 1135 of file field_iterator.cpp.
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 1468 of file field_iterator.cpp.
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 991 of file field_iterator.cpp.
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 1336 of file field_iterator.cpp.
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 1577 of file field_iterator.cpp.
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 1063 of file field_iterator.cpp.
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 1402 of file field_iterator.cpp.
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 1111 of file field_iterator.cpp.
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 1446 of file field_iterator.cpp.
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 1159 of file field_iterator.cpp.
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 1490 of file field_iterator.cpp.
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 1015 of file field_iterator.cpp.
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 1358 of file field_iterator.cpp.