SGRawValueFunctions Class Template Reference

#include <props.hxx>

Inherits SGRawValue< T >.

List of all members.


Detailed Description

template<class T>
class SGRawValueFunctions< T >

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

Definition at line 283 of file props.hxx.


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

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

Constructor & Destructor Documentation

SGRawValueFunctions ( getter_t  getter = 0,
setter_t  setter = 0 
) [inline]

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 307 of file props.hxx.


Member Function Documentation

virtual T getValue (  )  const [inline, virtual]

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.

Definition at line 322 of file props.hxx.

virtual bool setValue ( value  )  [inline, virtual]

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.

Definition at line 334 of file props.hxx.


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

Generated on Tue May 26 00:55:08 2009 for JSBSim Flight Dynamics Model by  doxygen 1.5.5