fawkes::InterfaceFieldIterator Class Reference
Interface field iterator. More...
#include <interface/interface.h>
Public Member Functions | |
| InterfaceFieldIterator () | |
| Constructor. | |
| InterfaceFieldIterator (const InterfaceFieldIterator &fit) | |
| Copy constructor. | |
| ~InterfaceFieldIterator () | |
| Destructor. | |
| InterfaceFieldIterator & | operator++ () |
| Prefix increment. | |
| InterfaceFieldIterator | operator++ (int inc) |
| Postfix increment operator. | |
| InterfaceFieldIterator & | operator+ (unsigned int i) |
| Advance by i steps. | |
| InterfaceFieldIterator & | operator+= (unsigned int i) |
| Advance by i steps. | |
| bool | operator== (const InterfaceFieldIterator &fit) const |
| Check iterators for equality. | |
| bool | operator!= (const InterfaceFieldIterator &fit) const |
| Check iterators for inequality. | |
| const void * | operator* () const |
| Get FieldHeader. | |
| InterfaceFieldIterator & | operator= (const InterfaceFieldIterator &fit) |
| Make this instance point to the same segment as fi. | |
| interface_fieldtype_t | get_type () const |
| Get type of current field. | |
| const char * | get_typename () const |
| Get type of current field as string. | |
| const char * | get_name () const |
| Get name of current field. | |
| const void * | get_value () const |
| Get value of current field. | |
| const char * | get_value_string () |
| Get value of current field as string. | |
| size_t | get_length () const |
| Get length of current field. | |
| bool | get_bool (unsigned int index=0) const |
| Get value of current field as bool. | |
| int | get_int (unsigned int index=0) const |
| Get value of current field as integer. | |
| unsigned int | get_uint (unsigned int index=0) const |
| Get value of current field as unsigned integer. | |
| long int | get_longint (unsigned int index=0) const |
| Get value of current field as long integer. | |
| unsigned long int | get_longuint (unsigned int index=0) const |
| Get value of current field as unsigned long int. | |
| float | get_float (unsigned int index=0) const |
| Get value of current field as float. | |
| unsigned char | get_byte (unsigned int index=0) const |
| Get value of current field as byte. | |
| bool * | get_bools () const |
| Get value of current field as bool array. | |
| int * | get_ints () const |
| Get value of current field as integer array. | |
| unsigned int * | get_uints () const |
| Get value of current field as unsigned integer array. | |
| long int * | get_longints () const |
| Get value of current field as long integer array. | |
| unsigned long int * | get_longuints () const |
| Get value of current field as unsigned long int array. | |
| float * | get_floats () const |
| Get value of current field as float array. | |
| unsigned char * | get_bytes () const |
| Get value of current field as byte array. | |
| const char * | get_string () const |
| Get value of current field as string. | |
| void | set_bool (bool b, unsigned int index=0) |
| Set value of current field as bool. | |
| void | set_int (int i, unsigned int index=0) |
| Set value of current field as integer. | |
| void | set_uint (unsigned int i, unsigned int index=0) |
| Set value of current field as unsigned integer. | |
| void | set_longint (long int i, unsigned int index=0) |
| Set value of current field as long integer. | |
| void | set_longuint (long unsigned int i, unsigned int index=0) |
| Set value of current field as unsigned long integer. | |
| void | set_float (float f, unsigned int index=0) |
| Set value of current field as float. | |
| void | set_byte (unsigned char b, unsigned int index=0) |
| Set value of current field as byte. | |
| void | set_bools (bool *b) |
| Set value of current field as bool array. | |
| void | set_ints (int *i) |
| Set value of current field as integer array. | |
| void | set_uints (unsigned int *i) |
| Set value of current field as unsigned integer array. | |
| void | set_longints (long int *i) |
| Set value of current field as long integer array. | |
| void | set_longuints (long unsigned int *i) |
| Set value of current field as unsigned long integer array. | |
| void | set_floats (float *f) |
| Set value of current field as float array. | |
| void | set_bytes (unsigned char *b) |
| Set value of current field as byte array. | |
| void | set_string (const char *s) |
| Set value of current field as string. | |
Protected Member Functions | |
| InterfaceFieldIterator (const interface_fieldinfo_t *info_list) | |
| Constructor. | |
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.
Definition at line 34 of file field_iterator.h.
Constructor & Destructor Documentation
| fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | ) |
| fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | const InterfaceFieldIterator & | fit | ) |
Copy constructor.
- Parameters:
-
fit iterator to copy
Definition at line 69 of file field_iterator.cpp.
| fawkes::InterfaceFieldIterator::~InterfaceFieldIterator | ( | ) |
| fawkes::InterfaceFieldIterator::InterfaceFieldIterator | ( | const interface_fieldinfo_t * | info_list | ) | [protected] |
Constructor.
This creates an iterator pointing to the given entry of the info list.
- Parameters:
-
info_list pointer to info list entry to start from
Definition at line 59 of file field_iterator.cpp.
Member Function Documentation
| bool fawkes::InterfaceFieldIterator::get_bool | ( | unsigned int | index = 0 |
) | const |
Get value of current field as bool.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
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 361 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.
- Returns:
- field value
- Exceptions:
-
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 514 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.
| unsigned char fawkes::InterfaceFieldIterator::get_byte | ( | unsigned int | index = 0 |
) | const |
Get value of current field as byte.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
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 493 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.
| unsigned char * fawkes::InterfaceFieldIterator::get_bytes | ( | ) | const |
Get value of current field as byte array.
- Returns:
- field value
- Exceptions:
-
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 630 of file field_iterator.cpp.
References fawkes::IFT_BYTE, 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.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
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 471 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.
- Returns:
- field value
- Exceptions:
-
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 611 of file field_iterator.cpp.
References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| int fawkes::InterfaceFieldIterator::get_int | ( | unsigned int | index = 0 |
) | const |
Get value of current field as integer.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
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 383 of file field_iterator.cpp.
References fawkes::IFT_INT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| int * fawkes::InterfaceFieldIterator::get_ints | ( | ) | const |
Get value of current field as integer array.
- Returns:
- field value
- Exceptions:
-
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 535 of file field_iterator.cpp.
References fawkes::IFT_INT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| size_t fawkes::InterfaceFieldIterator::get_length | ( | ) | const |
Get length of current field.
- Returns:
- length of field
Definition at line 263 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::length.
| long int fawkes::InterfaceFieldIterator::get_longint | ( | unsigned int | index = 0 |
) | const |
Get value of current field as long integer.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long int OutOfBoundsException thrown if index is out of bounds
Definition at line 427 of file field_iterator.cpp.
References fawkes::IFT_LONGINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| long int * fawkes::InterfaceFieldIterator::get_longints | ( | ) | const |
Get value of current field as long integer array.
- Returns:
- field value
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long int or field is not an array (length is 1)
Definition at line 573 of file field_iterator.cpp.
References fawkes::IFT_LONGINT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| unsigned long int fawkes::InterfaceFieldIterator::get_longuint | ( | unsigned int | index = 0 |
) | const |
Get value of current field as unsigned long int.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long unsigned int OutOfBoundsException thrown if index is out of bounds
Definition at line 449 of file field_iterator.cpp.
References fawkes::IFT_LONGUINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| unsigned long int * fawkes::InterfaceFieldIterator::get_longuints | ( | ) | const |
Get value of current field as unsigned long int array.
- Returns:
- field value
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long unsigned int or field is not an array (length is 1)
Definition at line 592 of file field_iterator.cpp.
References fawkes::IFT_LONGUINT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| const char * fawkes::InterfaceFieldIterator::get_name | ( | void | ) | const |
Get name of current field.
- Returns:
- field name
Definition at line 235 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.
- Returns:
- field value
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type string
Definition at line 648 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.
- Returns:
- field type
Definition at line 197 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.
- Returns:
- field type as string
Definition at line 211 of file field_iterator.cpp.
References fawkes::IFT_BOOL, fawkes::IFT_BYTE, fawkes::IFT_FLOAT, fawkes::IFT_INT, fawkes::IFT_LONGINT, fawkes::IFT_LONGUINT, fawkes::IFT_STRING, fawkes::IFT_UINT, and fawkes::interface_fieldinfo_t::type.
| unsigned int fawkes::InterfaceFieldIterator::get_uint | ( | unsigned int | index = 0 |
) | const |
Get value of current field as unsigned integer.
- Returns:
- field value
- Parameters:
-
index array index (only use if field is an array)
- Exceptions:
-
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 405 of file field_iterator.cpp.
References fawkes::IFT_UINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| unsigned int * fawkes::InterfaceFieldIterator::get_uints | ( | ) | const |
Get value of current field as unsigned integer array.
- Returns:
- field value
- Exceptions:
-
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 554 of file field_iterator.cpp.
References fawkes::IFT_UINT, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| const void * fawkes::InterfaceFieldIterator::get_value | ( | ) | const |
Get value of current field.
- Returns:
- field value
Definition at line 249 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::value.
| const char * fawkes::InterfaceFieldIterator::get_value_string | ( | ) |
Get value of current field as string.
- Returns:
- field value as string
Definition at line 277 of file field_iterator.cpp.
References fawkes::IFT_BOOL, fawkes::IFT_BYTE, fawkes::IFT_FLOAT, fawkes::IFT_INT, fawkes::IFT_LONGINT, fawkes::IFT_LONGUINT, fawkes::IFT_STRING, fawkes::IFT_UINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| bool fawkes::InterfaceFieldIterator::operator!= | ( | const InterfaceFieldIterator & | fi | ) | const |
Check iterators for inequality.
- Parameters:
-
fi iterator to compare to
- Returns:
- true if iteraters point to the different fields, false otherwise
Definition at line 160 of file field_iterator.cpp.
| const void * fawkes::InterfaceFieldIterator::operator* | ( | ) | const |
Get FieldHeader.
- Returns:
- shared memory header
Definition at line 170 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::value.
| InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+ | ( | unsigned int | i | ) |
Advance by i steps.
- Parameters:
-
i number of (matching) segments to advance.
- Returns:
- reference to this after advancing
Definition at line 121 of file field_iterator.cpp.
| InterfaceFieldIterator fawkes::InterfaceFieldIterator::operator++ | ( | int | inc | ) |
Postfix increment operator.
- Parameters:
-
inc ignored
- Returns:
- instance before advancing to the next shared memory segment
Definition at line 108 of file field_iterator.cpp.
| InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator++ | ( | ) |
Prefix increment.
- Returns:
- reference to this instance
Definition at line 91 of file field_iterator.cpp.
References fawkes::interface_fieldinfo_t::next.
| InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator+= | ( | unsigned int | i | ) |
Advance by i steps.
- Parameters:
-
i number of (matching) segments to advance.
- Returns:
- reference to this after advancing
Definition at line 135 of file field_iterator.cpp.
| InterfaceFieldIterator & fawkes::InterfaceFieldIterator::operator= | ( | const InterfaceFieldIterator & | fi | ) |
Make this instance point to the same segment as fi.
- Parameters:
-
fi field iterator to compare
- Returns:
- reference to this instance
Definition at line 185 of file field_iterator.cpp.
| bool fawkes::InterfaceFieldIterator::operator== | ( | const InterfaceFieldIterator & | fi | ) | const |
Check iterators for equality.
- Parameters:
-
fi iterator to compare to
- Returns:
- true if iterators point to the the same field, false otherwise
Definition at line 149 of file field_iterator.cpp.
| void fawkes::InterfaceFieldIterator::set_bool | ( | bool | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as bool.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
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 668 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.
| void fawkes::InterfaceFieldIterator::set_bools | ( | bool * | v | ) |
Set value of current field as bool array.
- Parameters:
-
v an array of bools
- Exceptions:
-
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 828 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.
| void fawkes::InterfaceFieldIterator::set_byte | ( | unsigned char | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as byte.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
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 806 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.
| void fawkes::InterfaceFieldIterator::set_bytes | ( | unsigned char * | v | ) |
Set value of current field as byte array.
- Parameters:
-
v an array of bytes
- Exceptions:
-
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 954 of file field_iterator.cpp.
References fawkes::IFT_BYTE, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::name, 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.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
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 783 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.
| void fawkes::InterfaceFieldIterator::set_floats | ( | float * | v | ) |
Set value of current field as float array.
- Parameters:
-
v an array of floats
- Exceptions:
-
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 933 of file field_iterator.cpp.
References fawkes::IFT_FLOAT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_int | ( | int | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as integer.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
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 691 of file field_iterator.cpp.
References fawkes::IFT_INT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_ints | ( | int * | v | ) |
Set value of current field as integer array.
- Parameters:
-
v an array of ints
- Exceptions:
-
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 849 of file field_iterator.cpp.
References fawkes::IFT_INT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_longint | ( | long int | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as long integer.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long int OutOfBoundsException thrown if index is out of bounds
Definition at line 737 of file field_iterator.cpp.
References fawkes::IFT_LONGINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_longints | ( | long int * | v | ) |
Set value of current field as long integer array.
- Parameters:
-
v an array of long ints
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long int or field is not an array (length is 1)
Definition at line 891 of file field_iterator.cpp.
References fawkes::IFT_LONGINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::name, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_longuint | ( | long unsigned int | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as unsigned long integer.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long unsigned int OutOfBoundsException thrown if index is out of bounds
Definition at line 760 of file field_iterator.cpp.
References fawkes::IFT_LONGUINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_longuints | ( | long unsigned int * | v | ) |
Set value of current field as unsigned long integer array.
- Parameters:
-
v an array of unsigned long ints
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type long unsigned int or field is not an array (length is 1)
Definition at line 912 of file field_iterator.cpp.
References fawkes::IFT_LONGUINT, fawkes::interface_fieldinfo_t::length, 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.
- Parameters:
-
v a string
- Exceptions:
-
NullPointerException invalid iterator, possibly end iterator TypeMismatchException thrown if field is not of type string
Definition at line 974 of file field_iterator.cpp.
References fawkes::IFT_STRING, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_uint | ( | unsigned int | v, | |
| unsigned int | index = 0 | |||
| ) |
Set value of current field as unsigned integer.
- Parameters:
-
v the new value index array index (only use if field is an array)
- Exceptions:
-
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 714 of file field_iterator.cpp.
References fawkes::IFT_UINT, fawkes::interface_fieldinfo_t::length, fawkes::interface_fieldinfo_t::type, and fawkes::interface_fieldinfo_t::value.
| void fawkes::InterfaceFieldIterator::set_uints | ( | unsigned int * | v | ) |
Set value of current field as unsigned integer array.
- Parameters:
-
v an array of unsigned ints
- Exceptions:
-
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 870 of file field_iterator.cpp.
References fawkes::IFT_UINT, fawkes::interface_fieldinfo_t::length, 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:
- src/libs/interface/field_iterator.h
- src/libs/interface/field_iterator.cpp

