European
Southern
Observatory

ESO — Reaching New Heights in Astronomy

Countries taking part in the ESO

VLT Software Documentation

mswINS_CONFIG_DATA Class Reference

See man page mswINS_CONFIG_DATA(4)
More...

#include <mswINS_CONFIG_DATA.h>

Inheritance diagram for mswINS_CONFIG_DATA:
Inheritance graph
[legend]
Collaboration diagram for mswINS_CONFIG_DATA:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 mswINS_CONFIG_DATA (const dbSYMADDRESS dbPoint=dbEMPTY)
virtual ~mswINS_CONFIG_DATA ()
mswINSID & InsId ()
mswINS_DATA_RECORD & InsData (const mswINSID &ins=mswSELECTED_INS)
vltLOGICAL IsInsData (const mswINSID &ins)
vltLOGICAL IsSelIns (const mswINSID &ins)
virtual ccsCOMPL_STAT DbPoint (const dbSYMADDRESS point)
virtual const char * DbPoint () const

Protected Member Functions

virtual ccsCOMPL_STAT LoadTable ()

Protected Attributes

dbSYMADDRESS modPoint
mswINS_DATA_RECORD insTable [mswNO_OF_INSTRUMENTS]

Private Attributes

mswINSID currentIns
mswINS_DATA_RECORD lastRecord
BYTES32 selectedIns
NONE Table data
 mswNO_OF_INSTRUMENTS
BYTES32 insId
BYTES32 BYTES32 insMode
BYTES32 BYTES32 INT32 focusStation
BYTES32 BYTES32 INT32 DOUBLE rotOffset
BYTES32 BYTES32 INT32 DOUBLE DOUBLE focusOffset
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE 		pixelSizeX
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE 		pixelSizeY
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE 		vigAreaSizeX
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE 		vigAreaSizeY
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE 		vigAreaCntX
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE 		vigAreaCntY
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE 		pointAxisOffX
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE 		pointAxisOffY
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE BYTES256 		detectorLcu
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE BYTES256 DOUBLE 		refX
BYTES32 BYTES32 INT32 DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE DOUBLE DOUBLE DOUBLE
DOUBLE BYTES256 DOUBLE DOUBLE 		refY

Detailed Description

See man page mswINS_CONFIG_DATA(4)
Manpage of mswINS_CONFIG_DATA

mswINS_CONFIG_DATA

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

NAME

mswINS_CONFIG_DATA - Access class to instrument configuration data

 

PARENT CLASS 


public eccsERROR_CLASS
 

DESCRIPTION 


  This class is part of the TCS-public msw library and provides
  access for TCS applications to instrument configuration data.
  It access the msw instrument database consiguration table
  and returns configuration information regarding the current
  instrument or any other instrument in the table.
 

PUBLIC METHODS 


  mswINS_CONFIG_DATA(const dbSYMADDRESS dbPoint = dbEMPTY);
    The constructor provides a default value for the dbPoint
    parameter to behave like two distinct constructors: one with
    no parameters and one with a dbPoint parameter.
    The first one defines the online database support point calling
    the standard tcsDbRoot(4) function and appending the
    default relative path from the TCS database root point,
    assuming a complete default TCS database structure.
    This is what will be generally used.
    The second one 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.
    This will be typically used for testing purposes.

  virtual ~mswINS_CONFIG_DATA();

  mswINSID           &InsId();
    Returns the id for the currently selected instrument.
    The returned value can change at the next call of a class
    method, so the user must copy the value locally upon return.

  mswINS_DATA_RECORD &InsData(const mswINSID &ins = mswSELECTED_INS);
    Returns the configuration data for the specified instrument
    or for the currently selected instrument.
    The returned value can change at the next call of a class
    method, so the user must copy the value locally upon return.
    See mswINS_DATA_RECORD(4) for detailes on the returned data

  vltLOGICAL          IsInsData(const mswINSID &ins);
    Returns TRUE if the given instrument is configured in the
    table and data can be retireved.
  vltLOGICAL          IsSelIns(const mswINSID &ins);
    Returns TRUE if the given instrument is the currently selected
    instrument.
  virtual ccsCOMPL_STAT       DbPoint(const dbSYMADDRESS point);
    Sets the database support point for the class, where the table
    is stored.
  virtual const char   *DbPoint() const;
    Returns the database support point for the class, where the table
    is stored.
 

PROTECTED METHODS 


  virtual ccsCOMPL_STAT  LoadTable();
    Loads into memory from the database the instrument configuration
    table. This is currently done every time data from the table is
    required. Since it is not foreseen an heavy usage of the class,
    no caching or optimization is performed.
 

PROTECTED DATA MEMBERS 


  These data members whould be private and encapsulated via
  access methods!

  dbSYMADDRESS        modPoint;
    Symbolic address of the database support point for the class.

  mswINS_DATA_RECORD  insTable[mswNO_OF_INSTRUMENTS];
    Full table of instruments.
    Loaded from the database every time LoadTable() is called
 

PRIVATE DATA MEMBERS 


  mswINSID            currentIns;  // The current selected instrument
  mswINS_DATA_RECORD  lastRecord;  // The last queried record
 

ON LINE DATABASE 


  These members are used to store the values retrieved by
  InsId() and InsData() methods.
  They can change at the next call of the methods, so the user
  must copy them upon return.

  The class assumes that the database support point is a subclass
  of mswINS_CONFIG_DATA, with the following structure:
    CLASS BASE_CLASS  mswINS_CONFIG_DATA                                    \\
    BEGIN                                                                   \\
       ATTRIBUTE BYTES32        selectedIns  "NONE"                         \\
       ATTRIBUTE Table          data( mswNO_OF_INSTRUMENTS,                 \\
                                      BYTES32    insId,                     \\
                                           .....                            \\
                                         )                                  \\
    END                                                                     \\
  The detailed definition of the table record format is important only
  for the class mswINS_DATA_RECORD(4); look there for details.
 

SEE ALSO 


eccsERROR_CLASS(4), mswINS_DATA_RECORD(4)
 

Index

NAME
PARENT CLASS
DESCRIPTION
PUBLIC METHODS
PROTECTED METHODS
PROTECTED DATA MEMBERS
PRIVATE DATA MEMBERS
ON LINE DATABASE
SEE ALSO
This document was created by man2html, using the manual pages.
Time: 10:09:27 GMT, April 23, 2012

Definition at line 33 of file mswINS_CONFIG_DATA.h.

Constructor & Destructor Documentation

mswINS_CONFIG_DATA::mswINS_CONFIG_DATA ( const dbSYMADDRESS  dbPoint = dbEMPTY  ) 
mswINS_CONFIG_DATA::~mswINS_CONFIG_DATA (  )  [virtual]

Definition at line 157 of file mswINS_CONFIG_DATA.C.

Member Function Documentation

const char * mswINS_CONFIG_DATA::DbPoint (  )  const [virtual]

Reimplemented in mswINS_DATA_MONITOR.

Definition at line 307 of file mswINS_CONFIG_DATA.C.

References modPoint.

ccsCOMPL_STAT mswINS_CONFIG_DATA::DbPoint ( const dbSYMADDRESS  point  )  [virtual]

Reimplemented in mswINS_DATA_MONITOR.

Definition at line 289 of file mswINS_CONFIG_DATA.C.

References modPoint, mswDB_ENTRY_POINT, mswDB_INS_DATA_POINT, and tcsMakeDbPoint().

mswINS_DATA_RECORD & mswINS_CONFIG_DATA::InsData ( const mswINSID &  ins = mswSELECTED_INS  ) 

Definition at line 181 of file mswINS_CONFIG_DATA.C.

References mswINS_DATA_RECORD::CleanUp(), InsId(), insTable, lastRecord, LoadTable(), mswERR_GET_INS, mswERR_INS_NOT_FOUND, mswMOD, and mswNO_OF_INSTRUMENTS.

Referenced by mswCONTROL_MAIN::GetInsDataCB(), mswCONTROL_MAIN::SetInsDataCB(), mswCONTROL_MAIN::TcsChangeFocusCB(), trkwsFOCUS_DATA::UpdateOffAxisTracking(), and trkwsFOCUS_DATA::UpdateRotator().

mswINSID & mswINS_CONFIG_DATA::InsId (  ) 

Definition at line 161 of file mswINS_CONFIG_DATA.C.

References currentIns, modPoint, mswDB_INS_ID_ATTR, mswERR_DB_READ_INS_ID, and mswMOD.

Referenced by mswCONTROL_MAIN::GetInsCB(), InsData(), IsInsData(), IsSelIns(), mswINS_CONFIG_TABLE::SetInsData(), and mswCONTROL_MAIN::TcsChangeFocusCB().

vltLOGICAL mswINS_CONFIG_DATA::IsInsData ( const mswINSID &  ins  ) 

Definition at line 234 of file mswINS_CONFIG_DATA.C.

References InsId(), insTable, LoadTable(), mswERR_GET_INS, mswMOD, mswNO_OF_INSTRUMENTS, and TRUE.

Referenced by mswCONTROL_MAIN::SetInsDataCB().

vltLOGICAL mswINS_CONFIG_DATA::IsSelIns ( const mswINSID &  ins  ) 

Definition at line 264 of file mswINS_CONFIG_DATA.C.

References InsId(), and TRUE.

Referenced by mswINS_CONFIG_TABLE::SetInsData(), and mswCONTROL_MAIN::SetInsDataCB().

ccsCOMPL_STAT mswINS_CONFIG_DATA::LoadTable (  )  [protected, virtual]

Definition at line 272 of file mswINS_CONFIG_DATA.C.

References insTable, modPoint, mswDB_INS_DATA_ATTR, mswERR_DB_LOAD_TABLE, and mswMOD.

Referenced by InsData(), IsInsData(), and mswINS_CONFIG_TABLE::SetInsData().

Member Data Documentation

mswINSID mswINS_CONFIG_DATA::currentIns [private]

Definition at line 65 of file mswINS_CONFIG_DATA.h.

Referenced by InsId().

NONE Table mswINS_CONFIG_DATA::data [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE BYTES256 mswINS_CONFIG_DATA::detectorLcu [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE mswINS_CONFIG_DATA::focusOffset [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 mswINS_CONFIG_DATA::focusStation [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 mswINS_CONFIG_DATA::insId [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 mswINS_CONFIG_DATA::insMode [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

mswINS_DATA_RECORD mswINS_CONFIG_DATA::insTable[mswNO_OF_INSTRUMENTS] [protected]

Definition at line 58 of file mswINS_CONFIG_DATA.h.

Referenced by InsData(), IsInsData(), LoadTable(), and mswINS_CONFIG_TABLE::SetInsData().

mswINS_DATA_RECORD mswINS_CONFIG_DATA::lastRecord [private]

Definition at line 66 of file mswINS_CONFIG_DATA.h.

Referenced by InsData().

dbSYMADDRESS mswINS_CONFIG_DATA::modPoint [protected]

Definition at line 54 of file mswINS_CONFIG_DATA.h.

Referenced by DbPoint(), InsId(), LoadTable(), mswINS_CONFIG_TABLE::SetInsData(), and mswINS_CONFIG_TABLE::SetInsId().

mswINS_CONFIG_DATA::mswNO_OF_INSTRUMENTS [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

Referenced by InsData(), IsInsData(), and mswINS_CONFIG_TABLE::SetInsData().

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::pixelSizeX [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::pixelSizeY [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::pointAxisOffX [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::pointAxisOffY [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE BYTES256 DOUBLE mswINS_CONFIG_DATA::refX [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE BYTES256 DOUBLE DOUBLE mswINS_CONFIG_DATA::refY [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE mswINS_CONFIG_DATA::rotOffset [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 mswINS_CONFIG_DATA::selectedIns [private]

Definition at line 45 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::vigAreaCntX [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::vigAreaCntY [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::vigAreaSizeX [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

BYTES32 BYTES32 INT32 DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE DOUBLE mswINS_CONFIG_DATA::vigAreaSizeY [private]

Definition at line 46 of file mswINS_CONFIG_DATA.class.

The documentation for this class was generated from the following files:
Generated on Mon Apr 23 10:12:39 2012 for INTROOT API by doxygen 1.6.3