SEPIA
Software documentation for the APEX SEPIA receivers
Property< T > Class Template Reference

A template class representing a device property. More...

#include <property.h>

Public Member Functions

commanded () const
 Read the commanded value. More...
 
actual () const
 Read the actual value. More...
 
void setCommanded (T value)
 Set a new commanded value. More...
 
void update (T value)
 Update the actual value. More...
 

Detailed Description

template<class T>
class Property< T >

A template class representing a device property.

A property has commanded and actual values. The commanded value can be set and read, whereas the actual value can only be read, but can change via an update, i.e. read from a hardware address.

Member Function Documentation

◆ actual()

template<class T >
T Property< T >::actual ( ) const

Read the actual value.

Returns
the actual value of type <T>

◆ commanded()

template<class T >
T Property< T >::commanded ( ) const

Read the commanded value.

Returns
the commanded value of type <T>

◆ setCommanded()

template<class T>
void Property< T >::setCommanded ( value)

Set a new commanded value.

Parameters
valuethe new commanded value of type <T>

◆ update()

template<class T>
void Property< T >::update ( value)

Update the actual value.

Parameters
valuethe new actual value of type <T>

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