ngc 1.5.0
 
Loading...
Searching...
No Matches
ngcdcsEXPDRV Class Reference

#include <ngcdcsEXPDRV.hpp>

Inheritance diagram for ngcdcsEXPDRV:
ngcbOBJ ngcdcsAOCAL ngcdcsEXP_TEST

Public Member Functions

 ngcdcsEXPDRV (const ngcb_fb_t &fb)
 Constructor with feed-back channel.
 
virtual ~ngcdcsEXPDRV ()
 Destructor.
 
int Initialized ()
 Return initialization flag.
 
FILE * FeedBackStream ()
 Return feed-back stream.
 
int ImgProcessor ()
 Return image-processor flag.
 
virtual int Configure (ngcbPARAM_LIST *cfg)
 Configuration call-back.
 
void GetCfg (ngcbPARAM_LIST *cfg)
 Get current configuration.
 
int Active ()
 Return active flag.
 
int NewSetup ()
 New setup available.
 
void Init ()
 Initiate exposure sequence.
 
int Next ()
 Execute next step in the exposure sequence.
 
void Terminate (int status=0)
 Terminate the exposure sequence.
 
int Delay ()
 Get delay (milliseconds) to be applied before next exposure.
 
virtual int Process (void *buffer, ngcdcs_finfo_t *finfo)
 Processing call-back.
 
virtual int MergeFits (ngcbFITS *hdr)
 FITS-header completion call-back.
 
- Public Member Functions inherited from ngcbOBJ
 ngcbOBJ ()
 Constructor.
 
virtual ~ngcbOBJ ()
 Destructor.
 
void Instance (int n)
 Set instance.
 
int Instance ()
 Get instance.
 
const char * Major ()
 Instance major number.
 
int BigEndian ()
 Big-endian architecture.
 
int LittleEndian ()
 Little-endian architecture.
 
virtual char * ErrMsg ()
 Error message.
 
virtual int Success ()
 Return success.
 
virtual int Failure ()
 Return failure.
 
void CfgPath (const char *path)
 Set external configuration path.
 

Public Attributes

char name [64]
 Exposure driver name.
 
int state
 State variable.
 
int acqId
 Associated acquisition module id.
 
unsigned int expId
 Exposure id.
 
ngcbPARAM_LIST setupList
 Setup parameter list.
 
ngcbPARAM_LISTparamList
 Global parameter list.
 
ngcbFITS fits
 Driver specific FITS-header.
 
- Public Attributes inherited from ngcbOBJ
FILE * watchdog
 Watchdog stream.
 
ngcbALARM_SYSalarmSystem
 Alarm system.
 
ngcbSERVICEservices
 System services.
 
int verboseLevel
 Verbose level.
 
int logLevel
 Logging level.
 
int xterm
 Xterm flag.
 
int debugPort
 Debug port.
 
int ignoreErr
 Ignore next error (do not log)
 
int type
 Object type.
 

Protected Member Functions

void Initialized (int flag)
 Set initialization flag.
 
void ImgProcessorOn ()
 Connect image-processor to all exposures.
 
void Delay (int ms)
 Set a delay (milliseconds) to be applied before next exposure.
 
int Status (const char *paramName, char *value)
 Get status value of a system parameter.
 
virtual int Exec ()
 Execution-block call-back.
 
virtual void Exit (int status)
 Exposure sequence exit function.
 
virtual void CfgStatus (ngcbPARAM_LIST *cfg)
 Configuration status call-back.
 
void SendFeedBack (const char *msg)
 Feed-back function.
 
- Protected Member Functions inherited from ngcbOBJ
virtual int BailOut (const char *pos)
 Log code position of the error and bail-out with failure.
 
virtual void Verbose (int level, const char *format,...) __attribute__((format(printf
 Verbose message if verbose level exceeds level.
 
virtual void virtual void Verbose (const char *format,...) __attribute__((format(printf
 Verbose message.
 
virtual void virtual void virtual void Log (int level, const char *format,...) __attribute__((format(printf
 Log message if logging level exceeds level.
 
virtual void virtual void virtual void virtual void Log (const char *format,...) __attribute__((format(printf
 Log message.
 
virtual void virtual void virtual void virtual void virtual void ErrLog (int severity, const char *format,...) __attribute__((format(printf
 Error log, severity is one of ngcbWARNING, ngcbFAILURE and ngcbERR_SEVERE.
 
virtual void virtual void virtual void virtual void virtual void void FeedBack (const char *format,...) __attribute__((format(printf
 Feed-back function.
 
const char * CfgPath ()
 Get external configuration path.
 
int CfgPath (char *path, const char *cfgFile)
 Compose path for configuratuion file.
 
int KeyVal (const char *key, float *value)
 Get single precision floating point value from keyword string.
 
int KeyVal (const char *key, double *value)
 Get double precision floating point value from keyword string.
 
int KeyVal (const char *key, int *value)
 Get 32-bit signed integer value from decimal keyword string.
 
int KeyVal (const char *key, unsigned int *value)
 Get 32-bit unsigned integer value from decimal keyword string.
 
int KeyValHex (const char *key, int *value)
 Get 32-bit signed integer value from hexadecimal keyword string.
 
int KeyValHex (const char *key, unsigned int *value)
 Get 32-bit unsigned integer value from hexadecimal keyword string.
 
int KeyValFmt (const char *key, int *value)
 Get 32-bit signed integer value from string.
 
int KeyValFmt (const char *key, unsigned int *value)
 Get 32-bit unsigned integer value from string.
 
int KeyValFrac (const char *key, unsigned int n, uint64_t *v1, uint64_t *v2)
 Fraction after n digits.
 
void CleanupCmd (char *cmdLine, int *cmdLen)
 Clean command string (remove extra spaces etc.)
 
int ReplaceParam (char *string)
 Replace parameter in string.
 

Detailed Description

Exposure driver base class

Constructor & Destructor Documentation

◆ ngcdcsEXPDRV()

ngcdcsEXPDRV::ngcdcsEXPDRV ( const ngcb_fb_t & fb)
inlineexplicit

Constructor with feed-back channel.

◆ ~ngcdcsEXPDRV()

virtual ngcdcsEXPDRV::~ngcdcsEXPDRV ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Active()

int ngcdcsEXPDRV::Active ( )
inline

Return active flag.

◆ CfgStatus()

virtual void ngcdcsEXPDRV::CfgStatus ( ngcbPARAM_LIST * cfg)
inlineprotectedvirtual

Configuration status call-back.

Reimplemented in ngcdcsAOCAL.

◆ Configure()

virtual int ngcdcsEXPDRV::Configure ( ngcbPARAM_LIST * cfg)
inlinevirtual

Configuration call-back.

Reimplemented in ngcdcsAOCAL.

◆ Delay() [1/2]

int ngcdcsEXPDRV::Delay ( )
inline

Get delay (milliseconds) to be applied before next exposure.

◆ Delay() [2/2]

void ngcdcsEXPDRV::Delay ( int ms)
inlineprotected

Set a delay (milliseconds) to be applied before next exposure.

◆ Exec()

virtual int ngcdcsEXPDRV::Exec ( )
inlineprotectedvirtual

Execution-block call-back.

Reimplemented in ngcdcsAOCAL, and ngcdcsEXP_TEST.

◆ Exit()

virtual void ngcdcsEXPDRV::Exit ( int status)
inlineprotectedvirtual

Exposure sequence exit function.

Reimplemented in ngcdcsAOCAL, and ngcdcsEXP_TEST.

◆ FeedBackStream()

FILE * ngcdcsEXPDRV::FeedBackStream ( )
inline

Return feed-back stream.

◆ GetCfg()

void ngcdcsEXPDRV::GetCfg ( ngcbPARAM_LIST * cfg)
inline

Get current configuration.

◆ ImgProcessor()

int ngcdcsEXPDRV::ImgProcessor ( )
inline

Return image-processor flag.

◆ ImgProcessorOn()

void ngcdcsEXPDRV::ImgProcessorOn ( )
inlineprotected

Connect image-processor to all exposures.

◆ Init()

void ngcdcsEXPDRV::Init ( )
inline

Initiate exposure sequence.

◆ Initialized() [1/2]

int ngcdcsEXPDRV::Initialized ( )
inline

Return initialization flag.

◆ Initialized() [2/2]

void ngcdcsEXPDRV::Initialized ( int flag)
inlineprotected

Set initialization flag.

◆ MergeFits()

virtual int ngcdcsEXPDRV::MergeFits ( ngcbFITS * hdr)
inlinevirtual

FITS-header completion call-back.

◆ NewSetup()

int ngcdcsEXPDRV::NewSetup ( )
inline

New setup available.

◆ Next()

int ngcdcsEXPDRV::Next ( )
inline

Execute next step in the exposure sequence.

◆ Process()

virtual int ngcdcsEXPDRV::Process ( void * buffer,
ngcdcs_finfo_t * finfo )
inlinevirtual

Processing call-back.

Reimplemented in ngcdcsAOCAL.

◆ SendFeedBack()

void ngcdcsEXPDRV::SendFeedBack ( const char * msg)
inlineprotectedvirtual

Feed-back function.

Reimplemented from ngcbOBJ.

◆ Status()

int ngcdcsEXPDRV::Status ( const char * paramName,
char * value )
inlineprotected

Get status value of a system parameter.

◆ Terminate()

void ngcdcsEXPDRV::Terminate ( int status = 0)
inline

Terminate the exposure sequence.

Member Data Documentation

◆ acqId

int ngcdcsEXPDRV::acqId

Associated acquisition module id.

◆ expId

unsigned int ngcdcsEXPDRV::expId

Exposure id.

◆ fits

ngcbFITS ngcdcsEXPDRV::fits

Driver specific FITS-header.

◆ name

char ngcdcsEXPDRV::name[64]

Exposure driver name.

◆ paramList

ngcbPARAM_LIST* ngcdcsEXPDRV::paramList

Global parameter list.

◆ setupList

ngcbPARAM_LIST ngcdcsEXPDRV::setupList

Setup parameter list.

◆ state

int ngcdcsEXPDRV::state

State variable.


The documentation for this class was generated from the following file: