STOFFVariable< T > Struct Template Reference

a generic variable template: value + flag to know if the variable is set More...

#include <libstaroffice_internal.hxx>

List of all members.

Public Member Functions

 STOFFVariable ()
 constructor
 STOFFVariable (T const &def)
 constructor with a default value
 STOFFVariable (STOFFVariable const &orig)
 copy constructor
STOFFVariableoperator= (STOFFVariable const &orig)
 copy operator
STOFFVariableoperator= (T const &val)
 set a value
void insert (STOFFVariable const &orig)
 update the current value if orig is set
T const * operator-> () const
 operator*
T * operator-> ()
 operator*
T const & operator* () const
 operator*
T & operator* ()
 operator*
T const & get () const
 return the current value
bool isSet () const
 return true if the variable is set
void setSet (bool newVal)
 define if the variable is set

Protected Attributes

m_data
 the value
bool m_set
 a flag to know if the variable is set or not

Detailed Description

template<class T>
struct STOFFVariable< T >

a generic variable template: value + flag to know if the variable is set

Note:
the variable is considered set as soon a new value is set or when its content is acceded by a function which returns a not-const reference... You can use the function setSet to unset it.

Constructor & Destructor Documentation

template<class T >
STOFFVariable< T >::STOFFVariable ( ) [inline]

constructor

template<class T >
STOFFVariable< T >::STOFFVariable ( T const &  def) [inline, explicit]

constructor with a default value

template<class T >
STOFFVariable< T >::STOFFVariable ( STOFFVariable< T > const &  orig) [inline]

copy constructor


Member Function Documentation

template<class T >
T const& STOFFVariable< T >::get ( ) const [inline]

return the current value

template<class T >
void STOFFVariable< T >::insert ( STOFFVariable< T > const &  orig) [inline]

update the current value if orig is set

template<class T >
bool STOFFVariable< T >::isSet ( ) const [inline]

return true if the variable is set

template<class T >
T const& STOFFVariable< T >::operator* ( ) const [inline]

operator*

template<class T >
T& STOFFVariable< T >::operator* ( ) [inline]

operator*

template<class T >
T const* STOFFVariable< T >::operator-> ( ) const [inline]

operator*

template<class T >
T* STOFFVariable< T >::operator-> ( ) [inline]

operator*

template<class T >
STOFFVariable& STOFFVariable< T >::operator= ( STOFFVariable< T > const &  orig) [inline]

copy operator

template<class T >
STOFFVariable& STOFFVariable< T >::operator= ( T const &  val) [inline]

set a value

template<class T >
void STOFFVariable< T >::setSet ( bool  newVal) [inline]

define if the variable is set


Member Data Documentation


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