head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.36; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.50; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.53.59; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.54; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# SGRawValueFunctions< T > Class Template Reference

A value managed through static functions. More...

`#include <props.hxx>`

Inheritance diagram for SGRawValueFunctions< 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 Methods
| 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 SGRawValue< T > * | clone () 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 279 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 303 of file props.hxx. References SGRawValueFunctions< T >::getter_t, and SGRawValueFunctions< T >::setter_t.

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

template<class T>
virtual bool SGRawValueFunctions< T >::setValue | ( | T | 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 330 of file props.hxx.

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

- props.hxx

@ 1.3 log @Oops, try again. @ text @d188 1 a188 1