Fawkes API  Fawkes Development Version
Public Member Functions
fawkes::InterfaceFieldPointer Class Reference

Direct pointer to an interface field. More...

#include <field_pointer.h>

Inheritance diagram for fawkes::InterfaceFieldPointer:
Inheritance graph
[legend]

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

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

Constructor & Destructor Documentation

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

Constructor.

Parameters:
typevalue type of the field
namename of the field
valuepointer to the value of the field

Definition at line 45 of file field_pointer.h.

Member Function Documentation

const char* fawkes::InterfaceFieldPointer::get_name ( void  ) const [inline]

Get name of the field.

Returns:
name of the field.

Definition at line 65 of file field_pointer.h.

Referenced by XabslInterfaceFieldWrapper< double, float >::get_name().

Interface::interface_fieldtype_t fawkes::InterfaceFieldPointer::get_type ( ) const [inline]

Get the type of the field.

Returns:
type of the field

Definition at line 57 of file field_pointer.h.

Referenced by XabslInterfaceFieldWrapper< double, float >::get_type().

FieldType fawkes::InterfaceFieldPointer::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.

Referenced by XabslInterfaceFieldWrapper< double, float >::get_value().

void fawkes::InterfaceFieldPointer::set_value ( FieldType  value) [inline]

Set value of the field.

Parameters:
valuenew value to set for the field.

Definition at line 81 of file field_pointer.h.

Referenced by XabslInterfaceFieldWrapper< double, float >::set_value().

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