Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals

dcs::fee::FeeItemInfo Class Reference

#include <FeeItemInfo.hpp>

Inheritance diagram for dcs::fee::FeeItemInfo:

dcs::fee::FeeInfo DimInfo

Detailed Description

Class, to subscribe and get access to the FEE - Item - service.

It inheritates from FeeInfo to get the DimInfo features, and to enable a polymorph access to the service data. Create objects of FeeItemInfo to get a connection to a given FEE Item on the server. The value is also updated after a certain timeout.

See also:
FeeInfo for more details
Author:
Christian Kofler, Sebastian Bablok
Date:
2003-08-27 (changed for LIB 2005-10-05)


Public Member Functions

 FeeItemInfo (FeeServiceStruct &fss, float noLink, DimInfoHandler *pHandler)
virtual ~FeeItemInfo ()
virtual bool retrieveServiceValue ()
virtual void initialize ()
float & getRefFloatValue ()

Private Attributes

float mValue
FeeServiceStruct mServiceInfo


Constructor & Destructor Documentation

dcs::fee::FeeItemInfo::FeeItemInfo FeeServiceStruct fss,
float  noLink,
DimInfoHandler *  pHandler
[inline]
 

Constructor for the FeeItemInfo, without service request after time intervals.

This constructor calls implictly the FeeInfo - constructor and with that the DimInfo constructor, so you subsrcibe to the inserted FEE - Item - Service (name).

Parameters:
fss pointer to the FeeServiceStruct, containing the name of the service to subscribe to and pointer to the handler routine
noLink value to be shown, when no connection to this service is available
pHandler pointer to the DimInfoHandler

virtual dcs::fee::FeeItemInfo::~FeeItemInfo  )  [inline, virtual]
 

Destructor for the FeeItemInfo objects.


Member Function Documentation

float & dcs::fee::FeeItemInfo::getRefFloatValue  )  [inline]
 

Getter for the reference to the service value.

Returns:
reference to the current value of this service

void FeeItemInfo::initialize  )  [virtual]
 

Function to set the initial value of this ItemInfo.

A possible "No link" at start up can be determined this way. This function should be called once after constructing this object.

Implements dcs::fee::FeeInfo.

bool FeeItemInfo::retrieveServiceValue  )  [virtual]
 

Function, to be executed when new data from the FEE - Item - Service is available.

It retrieves the data of the FeeServer from the DIM framework. It stores the value in the object itself. To get the value the the getValue function.

Returns:
true, if service is available, false in case of "no link"

Implements dcs::fee::FeeInfo.


Field Documentation

FeeServiceStruct dcs::fee::FeeItemInfo::mServiceInfo [private]
 

Service info containing the handler/callback routine for the FeeClientLib interface of this FeeService and the service name.

float dcs::fee::FeeItemInfo::mValue [private]
 

Here is the value of this Service stored.


The documentation for this class was generated from the following files:
Generated on Thu Mar 29 19:21:15 2007 for Fee Client Library by doxygen 1.3.5