trkwsTRANSFER_ASM Class Reference

See man page trkwsTRANSFER_ASM(4)

More...

#include <trkwsTRANSFER_ASM.h>

Inheritance diagram for trkwsTRANSFER_ASM:

[legend]

Collaboration diagram for trkwsTRANSFER_ASM:

[legend]

List of all members.

Public Member Functions
	trkwsTRANSFER_ASM (const dbSYMADDRESS dbPoint, const dbSYMADDRESS destDbPoint=NULL, const dbSYMADDRESS dbDataPoint=NULL)
	~trkwsTRANSFER_ASM ()
ccsCOMPL_STAT	Init ()
virtual evhCB_COMPL_STAT	InitCB (msgMESSAGE &msg, void *udata)
virtual evhCB_COMPL_STAT	ReadASMCB (msgMESSAGE &msg, void *udata)
Private Attributes
evhTIMER *	timer
msgMESSAGE	ASMData
dbSYMADDRESS	dataAddr
dbSYMADDRESS	dbDataPoint
vltUINT32	errorCounter
INT32	dataPollRate = 30
bytes256	dataAddr

Detailed Description

See man page trkwsTRANSFER_ASM(4)

Manpage of trkwsTRANSFER_ASM

trkwsTRANSFER_ASM

Section: Devices and Network Interfaces (4)
Updated: 2012-04-23 10:11
Index Return to man pages list

NAME

trkwsTRANSFER_ASM - handles reading, storing and distribution of data from the Astronomical Site Monitor for the Tracking module.

SYNOPSIS


#include "trkwsTRANSFER_ASM.h"

class trkwsTRANSFER_ASM : public trkwsTRANSFER
{
  public:
    trkwsTRANSFER_ASM(const dbSYMADDRESS dbPoint,
                      const dbSYMADDRESS destDbPoint = NULL,
                      const dbSYMADDRESS dbDataPoint = NULL);
    ~trkwsTRANSFER_ASM();

    ccsCOMPL_STAT Init();


    virtual evhCB_COMPL_STAT InitCB(msgMESSAGE &msg, void *udata);
    virtual evhCB_COMPL_STAT ReadASMCB(msgMESSAGE &msg, void *udata);

  protected:

  private:
    evhTIMER    *timer;
    msgMESSAGE   ASMData;
    dbSYMADDRESS dataAddr;
    dbSYMADDRESS dbDataPoint;

};

PARENT CLASS


trkwsTRANSFER

DESCRIPTION


When created, the object initialises database addresses to where to read
and where to store ASM data, and it creates a periodic call of its
callback ReadASM. The period is a configuration parameter which is read
from the database.
If the polling rate read from the database is <= 0, the periodic sending
of asm data is turned off.
The callback ReadASMCB will send the ASM-data to all LCUs currently
involved in tracking, by using the inherited SendAll method.
NOTE: there is no handling of replies, errors or time-outs on this
command-sending!

PUBLIC METHODS


trkwsTRANSFER_ASM(const dbSYMADDRESS dbPoint,
                  const dbSYMADDRESS destDbPoint = NULL);
                  const dbSYMADDRESS dbDataPoint = NULL);

  The constructor receives as parameter the symbolic address of
  online database support point for the object, i.e. the point
  where the object can find configuration and run time values.
  The destDbPoint parameter contains the address for the list
  of whom the ASM commands must be sent.
  The dbDataPoint, if not NULL, contains the address for the point
  where ASM data must be written. It assumes that this point has
  attributes with names befined by:
           trkwsENV_TEMP_ATTRNAME
           trkwsENV_PRES_ATTRNAME
           trkwsENV_HUM_ATTRNAME.
  If the parameter is null, nothing is written.
  The constructor calls the method Init() to read configuration
  parameters,to initialise data members and to initiate a periodic
  call.

 ~trkwsTRANSFER_ASM();

    The destructor deletes the timer, if there is any existing.

 ccsCOMPL_STAT Init();

   This method initialises database addresses to where to read
and where to store ASM data, and it creates a periodic call of its
callback ReadASM. The period is a configuration parameter which is read
from the database.

 virtual evhCB_COMPL_STAT InitCB(msgMESSAGE &msg, void *udata);

   This callback oveloads the inherited InitCB method. It is called every
 time when the main process (trkwsControl) receives an INIT command.
 The Init() method is first called, and then the ReadASMCB method, to
 make sure that ASM data are refreshed immediately, without having to
 wait for the first periodic call.

 virtual evhCB_COMPL_STAT ReadASMCB(msgMESSAGE &msg, void *udata);

   This is the callback that is called periodically. It reads data from
  the ASM database, sends the data to all LCUs curerntly involved in
  tracking, and stores tha data in the Tracking database, if required.

PRIVATE DATA MEMBERS


  evhTIMER    *timer;       object handling the periodic call
  msgMESSAGE   ASMData;     the message sent to all tracking LCUs
  dbSYMADDRESS dataAddr;    address of ASM data
  dbSYMADDRESS dbDataPoint; address of ASM data in Tracking database.

ON LINE DATABASE


The following database branch structure is used to handle
an object of class trkwsTRANSFER_ASM:

CLASS trkwsTRANSFER    trkwsTRANSFER_ASM

BEGIN


    ATTRIBUTE INT32       dataPollRate   30
    ATTRIBUTE bytes256    dataAddr          ""

END


dataAddr    must point to an instance of mswMOD_LIST_COMMAND_CLASS
dbDataPoint must point to an instance of trkwsDATA or must
            contain attributes as defined in
                 trkwsENV_TEMP_ATTRNAME
                 trkwsENV_PRES_ATTRNAME
                 trkwsENV_HUM_ATTRNAME.