European
Southern
Observatory

ESO — Reaching New Heights in Astronomy

Countries taking part in the ESO

VLT Software Documentation

mswINS_DATA_RECORD Class Reference

See man page mswINS_DATA_RECORD(4)
More...

#include <mswINS_DATA_RECORD.h>

List of all members.

Public Member Functions

 mswINS_DATA_RECORD ()
 mswINS_DATA_RECORD (const mswINS_DATA_RECORD &)
mswINS_DATA_RECORD & operator= (const mswINS_DATA_RECORD &)
virtual ~mswINS_DATA_RECORD ()
virtual ccsCOMPL_STAT Pack (void *buffer)
virtual ccsCOMPL_STAT Unpack (void *buffer)
virtual const char * Data ()
virtual ccsCOMPL_STAT Data (const char *msgBuffer)
virtual ccsCOMPL_STAT CleanUp ()
const vltLOGICAL IsInsId (const mswINSID &insId) const
const mswINSID & InsId () const
const mswINSMODE & InsMode () const
const vltINT32 FocusStation () const
const char * FocusStationName () const
const vltDOUBLE RotOffset () const
const vltDOUBLE FocusOffset () const
const vltDOUBLE AdFocusPos () const
const vltDOUBLE PixelSizeX () const
const vltDOUBLE PixelSizeY () const
const vltDOUBLE RefX () const
const vltDOUBLE RefY () const
const vltDOUBLE VigAreaSizeX () const
const vltDOUBLE VigAreaSizeY () const
const vltDOUBLE VigAreaCntX () const
const vltDOUBLE VigAreaCntY () const
const vltDOUBLE PointAxisOffX () const
const vltDOUBLE PointAxisOffY () const
const char * DetectorLCU () const

Private Attributes

mswINSID insId
mswINSID insMode
vltINT32 focusStation
vltDOUBLE rotOffset
vltDOUBLE focusOffset
vltDOUBLE adFocusPos
vltDOUBLE pixelSizeX
vltDOUBLE pixelSizeY
vltDOUBLE refX
vltDOUBLE refY
vltDOUBLE vigAreaSizeX
vltDOUBLE vigAreaSizeY
vltDOUBLE vigAreaCntX
vltDOUBLE vigAreaCntY
vltDOUBLE pointAxisOffX
vltDOUBLE pointAxisOffY
vltBYTES256 detectorLCU
fndSTRING cmdString

Detailed Description

See man page mswINS_DATA_RECORD(4)
Manpage of mswINS_DATA_RECORD

mswINS_DATA_RECORD

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

NAME

mswINS_DATA_RECORD - Instrument configuration record access class.

 

SYNOPSIS 


#include "mswINS_DATA_RECORD.h"

class  mswINS_DATA_RECORD: public eccsDB_TABLE_RECORD, public eccsERROR_CLASS
{
  public:
    mswINS_DATA_RECORD();
    mswINS_DATA_RECORD( const mswINS_DATA_RECORD& );
    mswINS_DATA_RECORD& operator           =( const mswINS_DATA_RECORD& );

    virtual ccsCOMPL_STAT Pack( void *buffer );
    virtual ccsCOMPL_STAT Unpack( void *buffer );

    virtual const char   *Data();
    virtual ccsCOMPL_STAT Data(const char *msgBuffer);

    virtual ccsCOMPL_STAT CleanUp();

    const vltLOGICAL IsInsId(const mswINSID &insId) const;

    const mswINSID   &InsId() const;
    const mswINSMODE &InsMode() const;
    const vltINT32    FocusStation() const;
    const char       *FocusStationName() const;
    const vltDOUBLE   RotOffset() const;
    const vltDOUBLE   FocusOffset() const;

    const vltDOUBLE   PixelSizeX() const;
    const vltDOUBLE   PixelSizeY() const;

    const vltDOUBLE   VigAreaSizeX() const;
    const vltDOUBLE   VigAreaSizeY() const;
    const vltDOUBLE   VigAreaCntX() const;
    const vltDOUBLE   VigAreaCntY() const;

    const vltDOUBLE   PointAxisOffX() const;
    const vltDOUBLE   PointAxisOffY() const;

    const char       *DetectorLCU() const;

  private:
    mswINSID    insId;           // identifier for a pair (ins,detector)
    mswINSID    insMode;         // identifier for instrument mode
    vltINT32    focusStation;    // instrument focus station (defines in mswDefines.h)

    vltDOUBLE   rotOffset;       // rotator offset (deg)
    vltDOUBLE   focusOffset;     // optimal focus offset (mm)

    vltDOUBLE   pixelSizeX;      // detector pixel size in X (arcsec/pixel)
    vltDOUBLE   pixelSizeY;      // detector pixel size in Y (arcsec/pixel)

    vltDOUBLE   vigAreaSizeX;    // vignetting area: X size (arcsec)
    vltDOUBLE   vigAreaSizeY;    // vignetting area: Y size (arcsec)
    vltDOUBLE   vigAreaCntX;     // vignetting area: X offset of center
                                 // with respect to center (arcsec)
    vltDOUBLE   vigAreaCntY;     // vignetting area: Y offset of center
                                 // with respect to center (arcsec)

    vltDOUBLE   pointAxisOffX;   // X pointing axis offset (arcsec)
    vltDOUBLE   pointAxisOffY;   // Y pointing axis offset (arcsec)

    vltBYTES256 detectorLCU;     // environment and process name

    fndSTRING cmdString;
};
 

PARENT CLASS 


public eccsDB_TABLE_RECORD
public eccsERROR_CLASS
 

DESCRIPTION 


This class provide access to records in the database table
keeping instrument configuration data for TCS.

The class is part of the TCS-public msw library and provide TCS-public
access to the instrument configuration data.

It is a subclass of the basic table record access class eccsDB_TABLE_RECORD(4)
but all data members are encapsulated in the private section and can be accesse
only via access methods.

The class mswINS_CONFIG_DATA(4) uses this class to provide access to the full
table.

Since some fields are not yet fully defined, the class is subject to changes
in the future, but they should be backward compatible, involving only
adding new fields and not changing the ones already defined.
 

PUBLIC METHODS 


  mswINS_DATA_RECORD();
  mswINS_DATA_RECORD( const mswINS_DATA_RECORD& );
    The class provides a default constructor and a copy constructor,
    required for a standard class implementation.

  mswINS_DATA_RECORD& operator           =( const mswINS_DATA_RECORD& );
    Assignement operator, required for a standard class implementation.

  virtual ccsCOMPL_STAT Pack( void *buffer );
  virtual ccsCOMPL_STAT Unpack( void *buffer );
    Pack() and Unpack() methods are required for the implementation
    of eccsDB_TABLE_RECORD subclasses and are used while
    accessing the database table to convert from RTAP internal
    format to C class members

  virtual const char   *Data();
  virtual ccsCOMPL_STAT Data(const char *msgBuffer);
    Methods to retrieve/set the instrument data configuration
    in the format of a message buffer for the commands GETINSD and
    SELINSD.
    See the command definition table for the process mswControl
    (mswControl.cdt) for detaild on the command format.
    The Data() set method is the only legal way to change the values
    of the fields in the record.

  virtual ccsCOMPL_STAT CleanUp();
    Empties the record, cleaning all data

  const vltLOGICAL IsInsId(const mswINSID &insId) const;
    Checks if a given mswINSID correspond to this record

 Read mode access methods for the record fields:

  const mswINSID   &InsId() const;
    Identifier for a pair (ins,detector)
  const mswINSMODE &InsMode() const;
    Identifier for instrument mode

  const vltINT32    FocusStation() const;
    Instrument focus station (defines in mswDefines.h)
  const char       *FocusStationName() const;
    Instrument focus station NAME

  const vltDOUBLE   RotOffset() const;
    Rotator offset (deg)
  const vltDOUBLE   FocusOffset() const;
    Optimal focus offset (mm)

  const vltDOUBLE   PixelSizeX() const;
  const vltDOUBLE   PixelSizeY() const;
    Detector pixel size in X and Y (arcsec/pixel)

  const vltDOUBLE   VigAreaSizeX() const;
  const vltDOUBLE   VigAreaSizeY() const;
  const vltDOUBLE   VigAreaCntX() const;
  const vltDOUBLE   VigAreaCntY() const;
    Vignetting area: (X,Y) size (arcsec)
    and (X,Y) offset of center
    with respect to center (arcsec)

  const vltDOUBLE   PointAxisOffX() const;
  const vltDOUBLE   PointAxisOffY() const;
    X and Y pointing axis offset (arcsec)

  const char       *DetectorLCU() const;
    environment and process name
 

PRIVATE DATA MEMBERS 


    mswINSID    insId;           // identifier for a pair (ins,detector)
    mswINSID    insMode;         // identifier for instrument mode
    vltINT32    focusStation;    // instrument focus station (defines in mswDefines.h)

    vltDOUBLE   rotOffset;       // rotator offset (deg)
    vltDOUBLE   focusOffset;     // optimal focus offset (mm)

    vltDOUBLE   pixelSizeX;      // detector pixel size in X (arcsec/pixel)
    vltDOUBLE   pixelSizeY;      // detector pixel size in Y (arcsec/pixel)

    vltDOUBLE   vigAreaSizeX;    // vignetting area: X size (arcsec)
    vltDOUBLE   vigAreaSizeY;    // vignetting area: Y size (arcsec)
    vltDOUBLE   vigAreaCntX;     // vignetting area: X offset of center
                                 // with respect to center (arcsec)
    vltDOUBLE   vigAreaCntY;     // vignetting area: Y offset of center
                                 // with respect to center (arcsec)

    vltDOUBLE   pointAxisOffX;   // X pointing axis offset (arcsec)
    vltDOUBLE   pointAxisOffY;   // Y pointing axis offset (arcsec)

    vltBYTES256 detectorLCU;     // environment and process name

    fndSTRING cmdString;         // internal buffer
 

ON LINE DATABASE 


The class assume that the following table structure
is accessed (see mswINS_CONFIG_DATA.class):

ATTRIBUTE Table          data( mswNO_OF_INSTRUMENTS,
                               BYTES32    insId,
                               BYTES32    insMode,
                               INT32      focusStation,
                               DOUBLE     rotOffset,
                               DOUBLE     focusOffset,
                               DOUBLE     pixelSizeX,
                               DOUBLE     pixelSizeY,
                               DOUBLE     vigAreaSizeX,
                               DOUBLE     vigAreaSizeY,
                               DOUBLE     vigAreaCntX,
                               DOUBLE     vigAreaCntY,
                               DOUBLE     pointAxisOffX,
                               DOUBLE     pointAxisOffY,
                               BYTES256   detectorLcu,
                               DOUBLE     refX,
                               DOUBLE     refY,
                               DOUBLE     adFocusPos)
 

TYPEDEFS 


  mswINSID;      // Type to contain and instrument ID definition string
  mswINSMODE;    // Type to contain an instrument mode definition string
 

CAUTIONS 


The database record structure is subject to changes, since
not all the features are fully defined at the present time.
 

SEE ALSO 


eccsDB_TABLE_RECORD(4), eccsERROR_CLASS(4), mswINS_CONFIG_DATA(4)
 

Index

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

Definition at line 40 of file mswINS_DATA_RECORD.h.

Constructor & Destructor Documentation

mswINS_DATA_RECORD::mswINS_DATA_RECORD (  )  [inline]

Definition at line 132 of file mswINS_DATA_RECORD.icc.

References CleanUp().

mswINS_DATA_RECORD::mswINS_DATA_RECORD ( const mswINS_DATA_RECORD &  source  )  [inline]

Definition at line 169 of file mswINS_DATA_RECORD.icc.

mswINS_DATA_RECORD::~mswINS_DATA_RECORD (  )  [inline, virtual]

Definition at line 137 of file mswINS_DATA_RECORD.icc.

Member Function Documentation

const vltDOUBLE mswINS_DATA_RECORD::AdFocusPos (  )  const [inline]

Definition at line 209 of file mswINS_DATA_RECORD.icc.

References adFocusPos.

ccsCOMPL_STAT mswINS_DATA_RECORD::CleanUp (  )  [inline, virtual]

Definition at line 105 of file mswINS_DATA_RECORD.icc.

References adFocusPos, detectorLCU, focusOffset, focusStation, insId, insMode, mswUNDEFINED_FOCUS, pixelSizeX, pixelSizeY, pointAxisOffX, pointAxisOffY, refX, refY, rotOffset, vigAreaCntX, vigAreaCntY, vigAreaSizeX, and vigAreaSizeY.

Referenced by mswINS_CONFIG_DATA::InsData(), and mswINS_DATA_RECORD().

ccsCOMPL_STAT mswINS_DATA_RECORD::Data ( const char *  msgBuffer  )  [virtual]

Definition at line 287 of file mswINS_DATA_RECORD.C.

References adFocusPos, detectorLCU, focusOffset, focusStation, insId, insMode, mswERR_ILL_FOCUS_STATION, mswERR_PARSE_INS_DATA, mswFocusNameMap, mswMOD, pixelSizeX, pixelSizeY, pointAxisOffX, pointAxisOffY, refX, refY, rotOffset, vigAreaCntX, vigAreaCntY, vigAreaSizeX, and vigAreaSizeY.

virtual const char* mswINS_DATA_RECORD::Data (  )  [virtual]

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

const char * mswINS_DATA_RECORD::DetectorLCU (  )  const [inline]

Definition at line 264 of file mswINS_DATA_RECORD.icc.

References detectorLCU.

const vltDOUBLE mswINS_DATA_RECORD::FocusOffset (  )  const [inline]

Definition at line 204 of file mswINS_DATA_RECORD.icc.

References focusOffset.

const vltINT32 mswINS_DATA_RECORD::FocusStation (  )  const [inline]

Definition at line 189 of file mswINS_DATA_RECORD.icc.

References focusStation.

Referenced by mswCONTROL_MAIN::SetInsDataCB(), and mswCONTROL_MAIN::TcsChangeFocusCB().

const char * mswINS_DATA_RECORD::FocusStationName (  )  const [inline]

Definition at line 194 of file mswINS_DATA_RECORD.icc.

References focusStation, and mswFocusNameMap.

Referenced by mswCONTROL_MAIN::TcsChangeFocusCB().

const mswINSID & mswINS_DATA_RECORD::InsId (  )  const [inline]

Definition at line 179 of file mswINS_DATA_RECORD.icc.

References insId.

Referenced by trkwsFOCUS_DATA::UpdateOffAxisTracking(), and trkwsFOCUS_DATA::UpdateRotator().

const mswINSMODE & mswINS_DATA_RECORD::InsMode (  )  const [inline]

Definition at line 184 of file mswINS_DATA_RECORD.icc.

References insMode.

const vltLOGICAL mswINS_DATA_RECORD::IsInsId ( const mswINSID &  insId  )  const [inline]

Definition at line 174 of file mswINS_DATA_RECORD.icc.

References insId, and TRUE.

mswINS_DATA_RECORD & mswINS_DATA_RECORD::operator= ( const mswINS_DATA_RECORD &  source  )  [inline]

Definition at line 141 of file mswINS_DATA_RECORD.icc.

References adFocusPos, detectorLCU, focusOffset, focusStation, insId, insMode, pixelSizeX, pixelSizeY, pointAxisOffX, pointAxisOffY, refX, refY, rotOffset, vigAreaCntX, vigAreaCntY, vigAreaSizeX, and vigAreaSizeY.

ccsCOMPL_STAT mswINS_DATA_RECORD::Pack ( void *  buffer  )  [inline, virtual]

Definition at line 74 of file mswINS_DATA_RECORD.icc.

References adFocusPos, detectorLCU, focusOffset, focusStation, insId, insMode, pixelSizeX, pixelSizeY, pointAxisOffX, pointAxisOffY, refX, refY, rotOffset, vigAreaCntX, vigAreaCntY, vigAreaSizeX, and vigAreaSizeY.

const vltDOUBLE mswINS_DATA_RECORD::PixelSizeX (  )  const [inline]

Definition at line 214 of file mswINS_DATA_RECORD.icc.

References pixelSizeX.

const vltDOUBLE mswINS_DATA_RECORD::PixelSizeY (  )  const [inline]

Definition at line 219 of file mswINS_DATA_RECORD.icc.

References pixelSizeY.

const vltDOUBLE mswINS_DATA_RECORD::PointAxisOffX (  )  const [inline]

Definition at line 254 of file mswINS_DATA_RECORD.icc.

References pointAxisOffX.

Referenced by trkwsFOCUS_DATA::UpdateOffAxisTracking().

const vltDOUBLE mswINS_DATA_RECORD::PointAxisOffY (  )  const [inline]

Definition at line 259 of file mswINS_DATA_RECORD.icc.

References pointAxisOffY.

Referenced by trkwsFOCUS_DATA::UpdateOffAxisTracking().

const vltDOUBLE mswINS_DATA_RECORD::RefX (  )  const [inline]

Definition at line 224 of file mswINS_DATA_RECORD.icc.

References refX.

const vltDOUBLE mswINS_DATA_RECORD::RefY (  )  const [inline]

Definition at line 229 of file mswINS_DATA_RECORD.icc.

References refY.

const vltDOUBLE mswINS_DATA_RECORD::RotOffset (  )  const [inline]

Definition at line 199 of file mswINS_DATA_RECORD.icc.

References rotOffset.

Referenced by trkwsFOCUS_DATA::UpdateRotator().

ccsCOMPL_STAT mswINS_DATA_RECORD::Unpack ( void *  buffer  )  [inline, virtual]

Definition at line 27 of file mswINS_DATA_RECORD.icc.

References adFocusPos, detectorLCU, focusOffset, focusStation, insId, insMode, pixelSizeX, pixelSizeY, pointAxisOffX, pointAxisOffY, refX, refY, rotOffset, vigAreaCntX, vigAreaCntY, vigAreaSizeX, and vigAreaSizeY.

const vltDOUBLE mswINS_DATA_RECORD::VigAreaCntX (  )  const [inline]

Definition at line 244 of file mswINS_DATA_RECORD.icc.

References vigAreaCntX.

const vltDOUBLE mswINS_DATA_RECORD::VigAreaCntY (  )  const [inline]

Definition at line 249 of file mswINS_DATA_RECORD.icc.

References vigAreaCntY.

const vltDOUBLE mswINS_DATA_RECORD::VigAreaSizeX (  )  const [inline]

Definition at line 234 of file mswINS_DATA_RECORD.icc.

References vigAreaSizeX.

const vltDOUBLE mswINS_DATA_RECORD::VigAreaSizeY (  )  const [inline]

Definition at line 239 of file mswINS_DATA_RECORD.icc.

References vigAreaSizeY.

Member Data Documentation

vltDOUBLE mswINS_DATA_RECORD::adFocusPos [private]

Definition at line 95 of file mswINS_DATA_RECORD.h.

Referenced by AdFocusPos(), CleanUp(), Data(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

fndSTRING mswINS_DATA_RECORD::cmdString [private]

Definition at line 114 of file mswINS_DATA_RECORD.h.

Referenced by tcsTCS_RCSID().

vltBYTES256 mswINS_DATA_RECORD::detectorLCU [private]

Definition at line 112 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), DetectorLCU(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::focusOffset [private]

Definition at line 94 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), FocusOffset(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

vltINT32 mswINS_DATA_RECORD::focusStation [private]

Definition at line 91 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), FocusStation(), FocusStationName(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

mswINSID mswINS_DATA_RECORD::insId [private]

Definition at line 89 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), InsId(), IsInsId(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

mswINSID mswINS_DATA_RECORD::insMode [private]

Definition at line 90 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), InsMode(), operator=(), Pack(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::pixelSizeX [private]

Definition at line 97 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), PixelSizeX(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::pixelSizeY [private]

Definition at line 98 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), PixelSizeY(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::pointAxisOffX [private]

Definition at line 109 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), PointAxisOffX(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::pointAxisOffY [private]

Definition at line 110 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), PointAxisOffY(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::refX [private]

Definition at line 99 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), RefX(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::refY [private]

Definition at line 100 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), RefY(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::rotOffset [private]

Definition at line 93 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), RotOffset(), tcsTCS_RCSID(), and Unpack().

vltDOUBLE mswINS_DATA_RECORD::vigAreaCntX [private]

Definition at line 104 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), tcsTCS_RCSID(), Unpack(), and VigAreaCntX().

vltDOUBLE mswINS_DATA_RECORD::vigAreaCntY [private]

Definition at line 106 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), tcsTCS_RCSID(), Unpack(), and VigAreaCntY().

vltDOUBLE mswINS_DATA_RECORD::vigAreaSizeX [private]

Definition at line 102 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), tcsTCS_RCSID(), Unpack(), and VigAreaSizeX().

vltDOUBLE mswINS_DATA_RECORD::vigAreaSizeY [private]

Definition at line 103 of file mswINS_DATA_RECORD.h.

Referenced by CleanUp(), Data(), operator=(), Pack(), tcsTCS_RCSID(), Unpack(), and VigAreaSizeY().

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