SGRawValueFunctions< T > Class Template Reference

A value managed through static functions. More...

#include <props.hxx>

Inheritance diagram for SGRawValueFunctions< T >:
SGRawValue< T >

List of all members.

Public Types

typedef T(* getter_t )()
 The template type of a static getter function.
typedef void(* setter_t )(T)
 The template type of a static setter function.

Public Member Functions

 SGRawValueFunctions (getter_t getter=0, setter_t setter=0)
 Explicit constructor.
virtual ~SGRawValueFunctions ()
 Destructor.
virtual T getValue () const
 Get the underlying value.
virtual bool setValue (T value)
 Set the underlying value.
virtual SGRawclone () const
 Create a copy of this raw value, bound to the same functions.

Detailed Description

template<class T>
class SGRawValueFunctions< T >

A value managed through static functions.

A read-only value will not have a setter; a write-only value will not have a getter.

Definition at line 453 of file props.hxx.


Constructor & Destructor Documentation

template<class T >
SGRawValueFunctions< T >::SGRawValueFunctions ( getter_t  getter = 0,
setter_t  setter = 0 
) [inline]

Explicit constructor.

Create a new raw value bound to the getter and setter supplied.

Parameters:
getter A static function for getting a value, or 0 to read-disable the value.
setter A static function for setting a value, or 0 to write-disable the value.

Definition at line 477 of file props.hxx.


Member Function Documentation

template<class T >
virtual T SGRawValueFunctions< T >::getValue (  )  const [inline, virtual]

Get the underlying value.

This method will invoke the getter function to get a value. If no getter function was supplied, this method will always return the default value for the type.

Implements SGRawValue< T >.

Definition at line 492 of file props.hxx.

template<class T >
virtual bool SGRawValueFunctions< T >::setValue ( value  )  [inline, virtual]

Set the underlying value.

This method will invoke the setter function to change the underlying value. If no setter function was supplied, this method will return false.

Implements SGRawValue< T >.

Definition at line 504 of file props.hxx.


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

Generated on 23 Feb 2010 for SimGear by  doxygen 1.6.1