fawkes::InterfaceFieldPointer< FieldType > Class Template Reference

Direct pointer to an interface field. More...

#include <field_pointer.h>

Inheritance diagram for fawkes::InterfaceFieldPointer< FieldType >:

List of all members.

Public Member Functions
	InterfaceFieldPointer (Interface::interface_fieldtype_t type, const char *name, FieldType *value)
	Constructor.
Interface::interface_fieldtype_t	get_type () const
	Get the type of the field.
const char *	get_name () const
	Get name of the field.
FieldType	get_value () const
	Get current value of the field.
void	set_value (FieldType value)
	Set value of the field.

---

Detailed Description

template<typename FieldType>
class fawkes::InterfaceFieldPointer< FieldType >

Direct pointer to an interface field.

This class allows for keeping a pointer to an interface value which is valid for the whole lifetime of the interface.

Author:

Tim Niemueller

Definition at line 37 of file field_pointer.h.

---

Constructor & Destructor Documentation

template<typename FieldType>

fawkes::InterfaceFieldPointer< FieldType >::InterfaceFieldPointer ( 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 45 of file field_pointer.h.

---

Member Function Documentation

template<typename FieldType>

const char* fawkes::InterfaceFieldPointer< FieldType >::get_name ( void  ) const

inline

Get name of the field.

Returns:

name of the field.

Definition at line 65 of file field_pointer.h.

template<typename FieldType>

Interface::interface_fieldtype_t fawkes::InterfaceFieldPointer< FieldType >::get_type ( ) const

inline

Get the type of the field.

Returns:

type of the field

Definition at line 57 of file field_pointer.h.

template<typename FieldType>

FieldType fawkes::InterfaceFieldPointer< FieldType >::get_value ( ) const

inline

Get current value of the field.

Returns:

current vlaue of the field.

Definition at line 73 of file field_pointer.h.

template<typename FieldType>

void fawkes::InterfaceFieldPointer< FieldType >::set_value ( FieldType  value )

inline

Set value of the field.

Parameters:

value

new value to set for the field.

Definition at line 81 of file field_pointer.h.

---

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

• src/libs/interface/field_pointer.h