Public Types | Public Member Functions | Protected Attributes
srs_env_model::CDataHolderBase< tpDataType > Class Template Reference

Data holder policy. More...

#include <server_tools.h>

List of all members.

Public Types

typedef tpDataType tData
 Data type.
typedef boost::shared_ptr
< const tData
tDataConstPtr
 Const data pointer type.
typedef boost::shared_ptr< tDatatDataPtr
 Data pointer type.
typedef boost::signal< void(tDataConstPtr,
const ros::Time &) > 
tSigDataHasChanged
 Data has changed signal type.

Public Member Functions

 CDataHolderBase ()
 Constructor.
 CDataHolderBase (tData *data)
 Constructor.
tDatagetData ()
 Get data reference.
const tDatagetData () const
 Get constant data reference.
tSigDataHasChangedgetSigDataChanged ()
 Get data has changed signal.
virtual bool hasValidData ()
 Data valid.
void invalidate ()
 Invalidate data - calls invalid signal.
virtual ~CDataHolderBase ()
 Virtual destructor.

Protected Attributes

tDataPtr m_data
 Data.
ros::Time m_DataTimeStamp
 Time stamp.
boost::mutex m_lockData
 You can use this mutex to lock data.
tSigDataHasChanged m_sigDataChanged
 Data changed signal.

Detailed Description

template<class tpDataType>
class srs_env_model::CDataHolderBase< tpDataType >

Data holder policy.

Definition at line 216 of file server_tools.h.


Member Typedef Documentation

template<class tpDataType>
typedef tpDataType srs_env_model::CDataHolderBase< tpDataType >::tData

Data type.

Definition at line 220 of file server_tools.h.

template<class tpDataType>
typedef boost::shared_ptr< const tData > srs_env_model::CDataHolderBase< tpDataType >::tDataConstPtr

Const data pointer type.

Definition at line 226 of file server_tools.h.

template<class tpDataType>
typedef boost::shared_ptr< tData > srs_env_model::CDataHolderBase< tpDataType >::tDataPtr

Data pointer type.

Definition at line 223 of file server_tools.h.

template<class tpDataType>
typedef boost::signal< void (tDataConstPtr, const ros::Time & ) > srs_env_model::CDataHolderBase< tpDataType >::tSigDataHasChanged

Data has changed signal type.

Definition at line 229 of file server_tools.h.


Constructor & Destructor Documentation

template<class tpDataType>
srs_env_model::CDataHolderBase< tpDataType >::CDataHolderBase ( ) [inline]

Constructor.

Definition at line 235 of file server_tools.h.

template<class tpDataType>
srs_env_model::CDataHolderBase< tpDataType >::CDataHolderBase ( tData data) [inline]

Constructor.

Definition at line 240 of file server_tools.h.

template<class tpDataType>
virtual srs_env_model::CDataHolderBase< tpDataType >::~CDataHolderBase ( ) [inline, virtual]

Virtual destructor.

Definition at line 244 of file server_tools.h.


Member Function Documentation

template<class tpDataType>
tData& srs_env_model::CDataHolderBase< tpDataType >::getData ( ) [inline]

Get data reference.

Definition at line 247 of file server_tools.h.

template<class tpDataType>
const tData& srs_env_model::CDataHolderBase< tpDataType >::getData ( ) const [inline]

Get constant data reference.

Definition at line 250 of file server_tools.h.

template<class tpDataType>
tSigDataHasChanged& srs_env_model::CDataHolderBase< tpDataType >::getSigDataChanged ( ) [inline]

Get data has changed signal.

Definition at line 253 of file server_tools.h.

template<class tpDataType>
virtual bool srs_env_model::CDataHolderBase< tpDataType >::hasValidData ( ) [inline, virtual]

Data valid.

Definition at line 256 of file server_tools.h.

template<class tpDataType>
void srs_env_model::CDataHolderBase< tpDataType >::invalidate ( ) [inline]

Invalidate data - calls invalid signal.

Definition at line 259 of file server_tools.h.


Member Data Documentation

template<class tpDataType>
tDataPtr srs_env_model::CDataHolderBase< tpDataType >::m_data [protected]

Data.

Definition at line 272 of file server_tools.h.

template<class tpDataType>
ros::Time srs_env_model::CDataHolderBase< tpDataType >::m_DataTimeStamp [protected]

Time stamp.

Definition at line 275 of file server_tools.h.

template<class tpDataType>
boost::mutex srs_env_model::CDataHolderBase< tpDataType >::m_lockData [protected]

You can use this mutex to lock data.

Definition at line 281 of file server_tools.h.

template<class tpDataType>
tSigDataHasChanged srs_env_model::CDataHolderBase< tpDataType >::m_sigDataChanged [protected]

Data changed signal.

Definition at line 278 of file server_tools.h.


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


srs_env_model
Author(s): Vit Stancl (stancl@fit.vutbr.cz), Tomas Lokaj, Jan Gorig, Michal Spanel (spanel@fit.vutbr.cz)
autogenerated on Sun Jan 5 2014 11:50:50