fawkes::InterfaceFieldIterator Class Reference

Interface field iterator. More...

#include <interface/interface.h>

List of all members.

Public Member Functions

 InterfaceFieldIterator ()
 Constructor.
 InterfaceFieldIterator (const InterfaceFieldIterator &fit)
 Copy constructor.
 ~InterfaceFieldIterator ()
 Destructor.
InterfaceFieldIteratoroperator++ ()
 Prefix increment.
InterfaceFieldIterator operator++ (int inc)
 Postfix increment operator.
InterfaceFieldIteratoroperator+ (unsigned int i)
 Advance by i steps.
InterfaceFieldIteratoroperator+= (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.
InterfaceFieldIteratoroperator= (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.
int8_t get_int8 (unsigned int index=0) const
 Get value of current field as integer.
uint8_t get_uint8 (unsigned int index=0) const
 Get value of current field as unsigned integer.
int16_t get_int16 (unsigned int index=0) const
 Get value of current field as integer.
uint16_t get_uint16 (unsigned int index=0) const
 Get value of current field as unsigned integer.
int32_t get_int32 (unsigned int index=0) const
 Get value of current field as integer.
uint32_t get_uint32 (unsigned int index=0) const
 Get value of current field as unsigned integer.
int64_t get_int64 (unsigned int index=0) const
 Get value of current field as integer.
uint64_t get_uint64 (unsigned int index=0) const
 Get value of current field as unsigned integer.
float get_float (unsigned int index=0) const
 Get value of current field as float.
uint8_t 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.
int8_t * get_int8s () const
 Get value of current field as integer array.
uint8_t * get_uint8s () const
 Get value of current field as unsigned integer array.
int16_t * get_int16s () const
 Get value of current field as integer array.
uint16_t * get_uint16s () const
 Get value of current field as unsigned integer array.
int32_t * get_int32s () const
 Get value of current field as integer array.
uint32_t * get_uint32s () const
 Get value of current field as unsigned integer array.
int64_t * get_int64s () const
 Get value of current field as integer array.
uint64_t * get_uint64s () const
 Get value of current field as unsigned integer array.
float * get_floats () const
 Get value of current field as float array.
uint8_t * 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_int8 (int8_t i, unsigned int index=0)
 Set value of current field as integer.
void set_uint8 (uint8_t i, unsigned int index=0)
 Set value of current field as unsigned integer.
void set_int16 (int16_t i, unsigned int index=0)
 Set value of current field as integer.
void set_uint16 (uint16_t i, unsigned int index=0)
 Set value of current field as unsigned integer.
void set_int32 (int32_t i, unsigned int index=0)
 Set value of current field as integer.
void set_uint32 (uint32_t i, unsigned int index=0)
 Set value of current field as unsigned integer.
void set_int64 (int64_t i, unsigned int index=0)
 Set value of current field as integer.
void set_uint64 (uint64_t i, unsigned int index=0)
 Set value of current field as unsigned integer.
void set_float (float f, unsigned int index=0)
 Set value of current field as float.
void set_byte (uint8_t 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_int8s (int8_t *i)
 Set value of current field as integer array.
void set_uint8s (uint8_t *i)
 Set value of current field as unsigned integer array.
void set_int16s (int16_t *i)
 Set value of current field as integer array.
void set_uint16s (uint16_t *i)
 Set value of current field as unsigned integer array.
void set_int32s (int32_t *i)
 Set value of current field as integer array.
void set_uint32s (uint32_t *i)
 Set value of current field as unsigned integer array.
void set_int64s (int64_t *i)
 Set value of current field as integer array.
void set_uint64s (uint64_t *i)
 Set value of current field as unsigned integer array.
void set_floats (float *f)
 Set value of current field as float array.
void set_bytes (uint8_t *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 *interface, 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.

Author:
Tim Niemueller

Definition at line 37 of file field_iterator.h.


Constructor & Destructor Documentation

fawkes::InterfaceFieldIterator::InterfaceFieldIterator (  ) 

Constructor.

Creates an invalid iterator.

Definition at line 49 of file field_iterator.cpp.

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

Copy constructor.

Parameters:
fit iterator to copy

Definition at line 74 of file field_iterator.cpp.

References __infol, and __value_string.

fawkes::InterfaceFieldIterator::~InterfaceFieldIterator (  ) 

Destructor.

Definition at line 86 of file field_iterator.cpp.

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

Constructor.

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

Parameters:
interface interface this field iterator is assigned to
info_list pointer to info list entry to start from

Definition at line 62 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 395 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 633 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.

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 612 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.

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 825 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 590 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 806 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.

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 460 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.

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 692 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.

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 503 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.

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 730 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.

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 546 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.

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 768 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.

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 417 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.

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 654 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.

Returns:
length of field

Definition at line 274 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::length.

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

Get name of current field.

Returns:
field name

Definition at line 246 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 843 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 203 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 217 of file field_iterator.cpp.

References fawkes::interface_fieldinfo_t::enumtype, fawkes::IFT_BOOL, fawkes::IFT_BYTE, 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.

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 482 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.

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 711 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.

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 525 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.

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 749 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.

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 568 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.

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 787 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.

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 439 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.

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 673 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.

Returns:
field value

Definition at line 260 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 288 of file field_iterator.cpp.

References fawkes::Interface::enum_tostring(), fawkes::interface_fieldinfo_t::enumtype, fawkes::IFT_BOOL, fawkes::IFT_BYTE, 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.

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

Get FieldHeader.

Returns:
shared memory header

Definition at line 175 of file field_iterator.cpp.

References 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 165 of file field_iterator.cpp.

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 126 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 113 of file field_iterator.cpp.

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

Prefix increment.

Returns:
reference to this instance

Definition at line 96 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 140 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 190 of file field_iterator.cpp.

References __infol, and __interface.

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 154 of file field_iterator.cpp.

References __infol.

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 863 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 1115 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 ( uint8_t  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 1093 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 ( uint8_t *  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 1325 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 1070 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 1304 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_int16 ( int16_t  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 932 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.

void fawkes::InterfaceFieldIterator::set_int16s ( int16_t *  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 1178 of file field_iterator.cpp.

References fawkes::IFT_INT16, 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_int32 ( int32_t  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 978 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.

void fawkes::InterfaceFieldIterator::set_int32s ( int32_t *  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 1220 of file field_iterator.cpp.

References fawkes::IFT_INT32, 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_int64 ( int64_t  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 1024 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.

void fawkes::InterfaceFieldIterator::set_int64s ( int64_t *  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 1262 of file field_iterator.cpp.

References fawkes::IFT_INT64, 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_int8 ( int8_t  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 886 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.

void fawkes::InterfaceFieldIterator::set_int8s ( int8_t *  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 1136 of file field_iterator.cpp.

References fawkes::IFT_INT8, 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 1345 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_uint16 ( uint16_t  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 955 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.

void fawkes::InterfaceFieldIterator::set_uint16s ( uint16_t *  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 1199 of file field_iterator.cpp.

References fawkes::IFT_UINT16, 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_uint32 ( uint32_t  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 1001 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.

void fawkes::InterfaceFieldIterator::set_uint32s ( uint32_t *  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 1241 of file field_iterator.cpp.

References fawkes::IFT_UINT32, 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_uint64 ( uint64_t  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 1047 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.

void fawkes::InterfaceFieldIterator::set_uint64s ( uint64_t *  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 1283 of file field_iterator.cpp.

References fawkes::IFT_UINT64, 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_uint8 ( uint8_t  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 909 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.

void fawkes::InterfaceFieldIterator::set_uint8s ( uint8_t *  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 1157 of file field_iterator.cpp.

References fawkes::IFT_UINT8, 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:
Generated on Tue Feb 22 13:31:39 2011 for Fawkes API by  doxygen 1.4.7