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

dcs::fee::FeeInfo Class Reference

#include <FeeInfo.hpp>

Inheritance diagram for dcs::fee::FeeInfo:

DimInfo dcs::fee::FeeAckInfo dcs::fee::FeeItemInfo dcs::fee::FeeMsgInfo

Detailed Description

Class, that wrapps the DimInfo - objects and offers a polymorph call to retrieve the service value from the DIM framework.

It inheritates the DIM features from DimInfo. To get the polymorph access, you need to instanciate objects from inheritated classes from FeeInfo.

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


Public Member Functions

 FeeInfo (char *name, void *noLink, int noLinkSize, DimInfoHandler *pHandler)
 FeeInfo (char *name, int time, float noLink, DimInfoHandler *pHandler)
 FeeInfo (char *name, float noLink, DimInfoHandler *pHandler)
virtual ~FeeInfo ()
virtual bool retrieveServiceValue ()=0
virtual void initialize ()=0


Constructor & Destructor Documentation

dcs::fee::FeeInfo::FeeInfo char *  name,
void *  noLink,
int  noLinkSize,
DimInfoHandler *  pHandler
[inline]
 

Constructor for the FeeInfo, when you want access to the Fee ACK - Service.

  • Normally, you will never call this constructor, use instead the FeeAckInfo, where this constructor is called implicitly. This constructor calls the DimInfo constructor where you automatically subscribe to inserted service (name).

Parameters:
name name of the service, to subscribe to
noLink pointer to value to be shown, when no connection to this service is available
noLinkSize size of the noLink - value
pHandler pointer to the DimInfoHandler

dcs::fee::FeeInfo::FeeInfo char *  name,
int  time,
float  noLink,
DimInfoHandler *  pHandler
[inline]
 

Constructor for the FeeInfo, when you want access to the Fee Item - Service.

  • Normally, you will never call this constructor, use instead the FeeItemInfo, where this constructor is called implicitly. This constructor calls the DimInfo constructor where you automatically subscribe to inserted service (name).

Parameters:
name name of the service, to subscribe to
time time interval, when to update service
noLink value to be shown, when no connection to this service is available
pHandler pointer to the DimInfoHandler

dcs::fee::FeeInfo::FeeInfo char *  name,
float  noLink,
DimInfoHandler *  pHandler
[inline]
 

Constructor for the FeeInfo, when you want access to the Fee Item - Service, here without regular service request after certain time intervals.

  • Normally, you will never call this constructor, use instead the FeeItemInfo, where this constructor is called implicitly. This constructor calls the DimInfo constructor where you automatically subscribe to inserted service (name).

Parameters:
name name of the service, to subscribe to
noLink value to be shown, when no connection to this service is available
pHandler pointer to the DimInfoHandler

FeeInfo::~FeeInfo  )  [virtual]
 

Destructor for the FeeInfo objects.

It is virtual, so the destructor of the derived class is also called, if the object is of this type (see Effective C++, page 60).


Member Function Documentation

virtual void dcs::fee::FeeInfo::initialize  )  [pure virtual]
 

Function to initialze the value of the info - object.

This function is virtual, because the implementation depends on the kind of DimInfo - object.

Implemented in dcs::fee::FeeAckInfo, dcs::fee::FeeItemInfo, and dcs::fee::FeeMsgInfo.

virtual bool dcs::fee::FeeInfo::retrieveServiceValue  )  [pure virtual]
 

Function, that executes polymorph the action, that should be performed when new data is retrieved from the FeeServer.

This function is pure virtual, because it should only be called from objects of the inherited classes. It stores the value in the object itself.

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

Implemented in dcs::fee::FeeAckInfo, dcs::fee::FeeItemInfo, and dcs::fee::FeeMsgInfo.


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