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.51; 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.55; 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

# SGRawValuePointer< T > Class Template Reference

A raw value bound to a pointer. More...

`#include <props.hxx>`

Inheritance diagram for SGRawValuePointer< T >:

List of all members.

## Public Methods
| SGRawValuePointer (T *ptr)
| Explicit pointer constructor.
virtual | ~SGRawValuePointer ()
| 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.

## Detailed Description

### template<class T>
class SGRawValuePointer< T >

A raw value bound to a pointer.

This is the most efficient way to tie an external value, but also the most dangerous, because there is no way for the supplier to perform bounds checking and derived calculations except by polling the variable to see if it has changed. There is no default constructor, because this class would be meaningless without a pointer.

Definition at line 222 of file props.hxx.

## Constructor & Destructor Documentation

template<class T>
SGRawValuePointer< T >::SGRawValuePointer | ( | T * | ptr | ) | `[inline]`

  | Explicit pointer constructor. Create a new raw value bound to the value of the variable referenced by the pointer. Parameters:
  ptr | The pointer to the variable to which this raw value will be bound.
Definition at line 235 of file props.hxx.

## Member Function Documentation

template<class T>
virtual SGRawValue<T>* SGRawValuePointer< T >::clone | ( |  | ) | const`[inline, virtual]`

| Create a copy of this raw value. The copy will use the same external pointer as the original. Implements SGRawValue< T >. Definition at line 263 of file props.hxx.

template<class T>
virtual T SGRawValuePointer< T >::getValue | ( |  | ) | const`[inline, virtual]`

| Get the underlying value. This method will dereference the pointer and return the variable's value. Implements SGRawValue< T >. Definition at line 248 of file props.hxx.

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

| Set the underlying value. This method will dereference the pointer and change the variable's value. Implements SGRawValue< T >. Definition at line 256 of file props.hxx.

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

- props.hxx

@ 1.3 log @Oops, try again. @ text @d205 1 a205 1