XabslInterfaceFieldWrapper Class Reference

Interface field wrapper for Xabsl. More...

#include <iface_field_wrapper.h>

Inheritance diagram for XabslInterfaceFieldWrapper:

List of all members.

Public Member Functions
	XabslInterfaceFieldWrapper (fawkes::Interface::interface_fieldtype_t type, const char *name, FieldType *value)
	Constructor.
	~XabslInterfaceFieldWrapper ()
	Destructor.
const char *	get_name () const
	Get name of the field.
fawkes::Interface::interface_fieldtype_t	get_type () const
	Get type of the field.
XabslType	get_value () const
	Get current value.
void	set_value (XabslType new_value)
	Set new value.

---

Detailed Description

Interface field wrapper for Xabsl.

This wraps a field of an iterface in a Xabsl function provider such that the field can be used as input and/or output symbol in Xabsl. This class does an implicit conversion of types. For instance in a BlackBoard interface floats are stored, while Xabsl requires doubles. With an explicit casting conversion code is generated by the compiler to make it work.

Author:

Tim Niemueller.

---

Constructor & Destructor Documentation

XabslInterfaceFieldWrapper::XabslInterfaceFieldWrapper	(	fawkes::Interface::interface_fieldtype_t	type,
		const char *	name,
		FieldType *	value
	)		[inline]

Constructor.

Parameters:

type	value type of the field
name	name of the field
value	pointer to the value of the field

Definition at line 47 of file iface_field_wrapper.h.

XabslInterfaceFieldWrapper::~XabslInterfaceFieldWrapper

(

)

[inline]

Destructor.

Definition at line 54 of file iface_field_wrapper.h.

---

Member Function Documentation

const char* XabslInterfaceFieldWrapper::get_name

(

void

)

const [inline]

Get name of the field.

Returns:

name of the field.

Definition at line 62 of file iface_field_wrapper.h.

fawkes::Interface::interface_fieldtype_t XabslInterfaceFieldWrapper::get_type

(

)

const [inline]

Get type of the field.

Returns:

type of the field.

Definition at line 70 of file iface_field_wrapper.h.

XabslType XabslInterfaceFieldWrapper::get_value

(

)

const [inline]

Get current value.

Returns:

current value in the Xabsl type

Definition at line 78 of file iface_field_wrapper.h.

void XabslInterfaceFieldWrapper::set_value

(

XabslType

new_value

)

[inline]

Set new value.

Parameters:

new_value

new value, converted to field type

Definition at line 86 of file iface_field_wrapper.h.

---

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

• src/plugins/xabsl/iface_field_wrapper.h