ngcdcsEXP Class Reference

#include <ngcdcsEXP.hpp>

Public Member Functions
ngcdcsEXP &	operator= (const ngcdcsEXP &other)
	Operator =.
	ngcdcsEXP (const ngcdcsEXP &other)
	Copy constructor.
	ngcdcsEXP ()
	Constructor.
virtual	~ngcdcsEXP ()
	Destructor.
void	SetFdIn (int f)
	Set incoming file descriptor.
void	SetFdOut (int f)
	Set outgoing file descriptor.
void	ResetFd ()
	Reset in/out file descriptors.
int	StatusFdIn ()
	Get incoming file descriptor.
int	StatusFdOut ()
	Get outgoing file descriptor.
int	Active ()
	Check if exposure is active.
void	Lock ()
	Lock access to exposure handler.
void	Unlock ()
	Unlock access to exposure handler.
void	ResetInstLock ()
	Reset synchronous instance locking.
void	InitInstLock (int n)
	Initialize synchronous instance locking.
void	Lock (int inst)
	Synchronous instance lock with defined order.
void	Unlock (int inst)
	Synchronous instance unlock with defined order.
void	Release ()
	Release exposure handler locking.
void	Attach (int inst)
	Add instance to instance-management lists.
void	Detach ()
	Remove all instances from instance-management lists.
void	Detach (int inst)
	Remove instance from instance-management lists.
int	LastTransfer (int inst)
	Check if the given instance is in last-transfer state.
int	LastTransfer ()
	Check if all attached (active) instances are in last-transfer state.
int	Attached ()
int	Aborted ()
int	IssueEvt (ngcdcs_expevt_t evt)
	Issue status event.
int	RecvEvt (ngcdcs_expevt_t *evt)
	Receive status event.
int	WaitApplLocked ()
	Wait until application is locked.
void	ApplLocked ()
	Signal that application is locked.
void	ApplRelease ()
	Release application lock.
void	ApplClear ()
	Clear application lock.
int	ApplCancelled ()
	Check if application lock was cancelled.
int	ApplSkip ()
	Skip locking message.
char *	ErrMsg ()
	Return a pointer to the actual error message.
int	Format (const char *name)
	Set exposure data file format (as string)
int	Format (int newFormat)
	Set exposure data file format.
int	Format ()
	Return exposure file format.
const char *	FormatName ()
	Return exposure file format name.
const char *	FormatNameELT ()
	Return exposure file format name (ELT)
int	Naming (int newNaming)
	Set naming scheme.
int	Naming ()
	Return naming scheme.
int	DataPath (const char *path)
	Set data path.
char *	DataPath ()
	Return data path.
int	BaseName (const char *name)
	Set exposure base name.
const char *	BaseName ()
	Get exposure base name.
void	AssignUUID (const char *value)
	Assign UUID.
const char *	Path ()
	Get full path to base name.
const char *	TmpPath ()
	Get tmp-file path.
int	NextIndex ()
	Create next exposure sequence index.
void	StatStr (char *s)
	Get status string.
void	Stat2Str (char *s, unsigned int stat)
	Map status to string.
void	ExpStartTime (struct timeval &timeVal)
	Set exposure start time.
const char *	ExpStartTime ()
	Get exposure start time (string)
double	ExpStartTimeMJD ()
	Get exposure start time (MJD)
double	ExpStartTimeUTC ()
	Get exposure start time (UTC seconds since midnight)
void	TimeStamp ()
	Generate exposure start time-stamp.
void	DrvStatus (unsigned int stat)
	Update exposure sequence driver status.
void	EndFlag (int flag)
	Set/clear end-flag.
int	EndFlag ()
	Get end-flag.

Public Attributes
int	extFits
	Flag for extended FITS header.
int	numExtBlocks
	Number of extension header blocks to be reserved.
int	sequenceNumber
	Sequence number.
int	oneFile
	All in one file ("Extension" format only)
int	instLock
	Lock instances for guaranteed order.
int	split
	Split glued images into extensions.
char	fileName [512]
	Common file name for this file.
FILE *	fd
	Shared file descriptor.
FILE *	fdList
	List file descriptor.
int	nopen
	Counts how many objects access this file.
int	merge
	Merge flag.
ngcbFITS	fits
	FITS-keyword object.
ngcbFITS	appHdr
	FITS-keyword object for application specific extension.
unsigned int	status
	Exposure status.
unsigned int	statusSaved
	Saved exposure status.
int	format
	Data file format.
int	naming
	Naming scheme.
int	time
	Estimation for exposure time.
char	baseName [256]
	Base name.
char	lastName [256+16]
	Last base name incl. sequence number.
char	id [64]
	Recording ID.
char	uuid [48]
	Unique ID.
int	rev
	Exposure handling revision.
double	integrationTime
	Integration time (for FITS header EXPTIME)
int	fileCheck
	Check file permissions.
int	useLock
	Flag to use application locking mechanism.
int	expType
	Exposure type.
int	secure
	Secure mode.
int	tmpFile
	Store tmeporary file.
int	checkFrames
	Check frame selection at exposure start.
int	numFitsExt
	Number of FITS-extensions generated during last exposure.
int	numFiles
	Number of files generated during last exposure.
struct timeval	startTime
	Start time-stamp.
unsigned int	drvStatus
	Exposure driver status.
char	drvStatusName [32]
	Exposure driver status name.
char	drvMsg [256]
	Exposure driver status message.
char	origin [80]
	ORIGIN keyword.

Detailed Description

NGC exposure class

Constructor & Destructor Documentation

ngcdcsEXP() [1/2]

ngcdcsEXP::ngcdcsEXP ( const ngcdcsEXP & other )

inline

Copy constructor.

ngcdcsEXP() [2/2]

ngcdcsEXP::ngcdcsEXP ( )

inline

Constructor.

~ngcdcsEXP()

virtual ngcdcsEXP::~ngcdcsEXP ( )

inlinevirtual

Destructor.

Member Function Documentation

Aborted()

int ngcdcsEXP::Aborted ( )

inline

Check if at least one instance was aborted. This will mark the whole thing as aborted.

Active()

int ngcdcsEXP::Active ( )

inline

Check if exposure is active.

ApplCancelled()

int ngcdcsEXP::ApplCancelled ( )

inline

Check if application lock was cancelled.

ApplClear()

void ngcdcsEXP::ApplClear ( )

inline

Clear application lock.

ApplLocked()

void ngcdcsEXP::ApplLocked ( )

inline

Signal that application is locked.

ApplRelease()

void ngcdcsEXP::ApplRelease ( )

inline

Release application lock.

ApplSkip()

int ngcdcsEXP::ApplSkip ( )

inline

Skip locking message.

AssignUUID()

void ngcdcsEXP::AssignUUID ( const char * value )

inline

Assign UUID.

Attach()

void ngcdcsEXP::Attach ( int inst )

inline

Add instance to instance-management lists.

Attached()

int ngcdcsEXP::Attached ( )

inline

Check if at least one instance is still attached (active). This will mark the whole thing as attached.

BaseName() [1/2]

const char * ngcdcsEXP::BaseName ( )

inline

Get exposure base name.

BaseName() [2/2]

int ngcdcsEXP::BaseName ( const char * name )

inline

Set exposure base name.

DataPath() [1/2]

char * ngcdcsEXP::DataPath ( )

inline

Return data path.

DataPath() [2/2]

int ngcdcsEXP::DataPath ( const char * path )

inline

Set data path.

Detach() [1/2]

void ngcdcsEXP::Detach ( )

inline

Remove all instances from instance-management lists.

Detach() [2/2]

void ngcdcsEXP::Detach ( int inst )

inline

Remove instance from instance-management lists.

DrvStatus()

void ngcdcsEXP::DrvStatus ( unsigned int stat )

inline

Update exposure sequence driver status.

EndFlag() [1/2]

int ngcdcsEXP::EndFlag ( )

inline

Get end-flag.

EndFlag() [2/2]

void ngcdcsEXP::EndFlag ( int flag )

inline

Set/clear end-flag.

ErrMsg()

char * ngcdcsEXP::ErrMsg ( )

inline

Return a pointer to the actual error message.

ExpStartTime() [1/2]

const char * ngcdcsEXP::ExpStartTime ( )

inline

Get exposure start time (string)

ExpStartTime() [2/2]

void ngcdcsEXP::ExpStartTime ( struct timeval & timeVal )

inline

Set exposure start time.

ExpStartTimeMJD()

double ngcdcsEXP::ExpStartTimeMJD ( )

inline

Get exposure start time (MJD)

ExpStartTimeUTC()

double ngcdcsEXP::ExpStartTimeUTC ( )

inline

Get exposure start time (UTC seconds since midnight)

Format() [1/3]

int ngcdcsEXP::Format ( )

inline

Return exposure file format.

Format() [2/3]

int ngcdcsEXP::Format ( const char * name )

inline

Set exposure data file format (as string)

Format() [3/3]

int ngcdcsEXP::Format ( int newFormat )

inline

Set exposure data file format.

FormatName()

const char * ngcdcsEXP::FormatName ( )

inline

Return exposure file format name.

FormatNameELT()

const char * ngcdcsEXP::FormatNameELT ( )

inline

Return exposure file format name (ELT)

InitInstLock()

void ngcdcsEXP::InitInstLock ( int n )

inline

Initialize synchronous instance locking.

IssueEvt()

int ngcdcsEXP::IssueEvt ( ngcdcs_expevt_t evt )

inline

Issue status event.

LastTransfer() [1/2]

int ngcdcsEXP::LastTransfer ( )

inline

Check if all attached (active) instances are in last-transfer state.

LastTransfer() [2/2]

int ngcdcsEXP::LastTransfer ( int inst )

inline

Check if the given instance is in last-transfer state.

Lock() [1/2]

void ngcdcsEXP::Lock ( )

inline

Lock access to exposure handler.

Lock() [2/2]

void ngcdcsEXP::Lock ( int inst )

inline

Synchronous instance lock with defined order.

Naming() [1/2]

int ngcdcsEXP::Naming ( )

inline

Return naming scheme.

Naming() [2/2]

int ngcdcsEXP::Naming ( int newNaming )

inline

Set naming scheme.

NextIndex()

int ngcdcsEXP::NextIndex ( )

inline

Create next exposure sequence index.

operator=()

ngcdcsEXP & ngcdcsEXP::operator= ( const ngcdcsEXP & other )

inline

Operator =.

Path()

const char * ngcdcsEXP::Path ( )

inline

Get full path to base name.

RecvEvt()

int ngcdcsEXP::RecvEvt ( ngcdcs_expevt_t * evt )

inline

Receive status event.

Release()

void ngcdcsEXP::Release ( )

inline

Release exposure handler locking.

ResetFd()

void ngcdcsEXP::ResetFd ( )

inline

Reset in/out file descriptors.

ResetInstLock()

void ngcdcsEXP::ResetInstLock ( )

inline

Reset synchronous instance locking.

SetFdIn()

void ngcdcsEXP::SetFdIn ( int f )

inline

Set incoming file descriptor.

SetFdOut()

void ngcdcsEXP::SetFdOut ( int f )

inline

Set outgoing file descriptor.

Stat2Str()

void ngcdcsEXP::Stat2Str ( char * s, unsigned int stat )

inline

Map status to string.

StatStr()

void ngcdcsEXP::StatStr ( char * s )

inline

Get status string.

StatusFdIn()

int ngcdcsEXP::StatusFdIn ( )

inline

Get incoming file descriptor.

StatusFdOut()

int ngcdcsEXP::StatusFdOut ( )

inline

Get outgoing file descriptor.

TimeStamp()

void ngcdcsEXP::TimeStamp ( )

inline

Generate exposure start time-stamp.

TmpPath()

const char * ngcdcsEXP::TmpPath ( )

inline

Get tmp-file path.

Unlock() [1/2]

void ngcdcsEXP::Unlock ( )

inline

Unlock access to exposure handler.

Unlock() [2/2]

void ngcdcsEXP::Unlock ( int inst )

inline

Synchronous instance unlock with defined order.

WaitApplLocked()

int ngcdcsEXP::WaitApplLocked ( )

inline

Wait until application is locked.

Member Data Documentation

appHdr

ngcbFITS ngcdcsEXP::appHdr

FITS-keyword object for application specific extension.

baseName

char ngcdcsEXP::baseName[256]

Base name.

checkFrames

int ngcdcsEXP::checkFrames

Check frame selection at exposure start.

drvMsg

char ngcdcsEXP::drvMsg[256]

Exposure driver status message.

drvStatus

unsigned int ngcdcsEXP::drvStatus

Exposure driver status.

drvStatusName

char ngcdcsEXP::drvStatusName[32]

Exposure driver status name.

expType

int ngcdcsEXP::expType

Exposure type.

extFits

int ngcdcsEXP::extFits

Flag for extended FITS header.

fd

FILE* ngcdcsEXP::fd

Shared file descriptor.

fdList

FILE* ngcdcsEXP::fdList

List file descriptor.

fileCheck

int ngcdcsEXP::fileCheck

Check file permissions.

fileName

char ngcdcsEXP::fileName[512]

Common file name for this file.

fits

ngcbFITS ngcdcsEXP::fits

FITS-keyword object.

format

int ngcdcsEXP::format

Data file format.

id

char ngcdcsEXP::id[64]

Recording ID.

instLock

int ngcdcsEXP::instLock

Lock instances for guaranteed order.

integrationTime

double ngcdcsEXP::integrationTime

Integration time (for FITS header EXPTIME)

lastName

char ngcdcsEXP::lastName[256+16]

Last base name incl. sequence number.

merge

int ngcdcsEXP::merge

Merge flag.

naming

int ngcdcsEXP::naming

Naming scheme.

nopen

int ngcdcsEXP::nopen

Counts how many objects access this file.

numExtBlocks

int ngcdcsEXP::numExtBlocks

Number of extension header blocks to be reserved.

numFiles

int ngcdcsEXP::numFiles

Number of files generated during last exposure.

numFitsExt

int ngcdcsEXP::numFitsExt

Number of FITS-extensions generated during last exposure.

oneFile

int ngcdcsEXP::oneFile

All in one file ("Extension" format only)

origin

char ngcdcsEXP::origin[80]

ORIGIN keyword.

rev

int ngcdcsEXP::rev

Exposure handling revision.

secure

int ngcdcsEXP::secure

Secure mode.

sequenceNumber

int ngcdcsEXP::sequenceNumber

Sequence number.

split

int ngcdcsEXP::split

Split glued images into extensions.

startTime

struct timeval ngcdcsEXP::startTime

Start time-stamp.

status

unsigned int ngcdcsEXP::status

Exposure status.

statusSaved

unsigned int ngcdcsEXP::statusSaved

Saved exposure status.

time

int ngcdcsEXP::time

Estimation for exposure time.

tmpFile

int ngcdcsEXP::tmpFile

Store tmeporary file.

useLock

int ngcdcsEXP::useLock

Flag to use application locking mechanism.

uuid

char ngcdcsEXP::uuid[48]

Unique ID.

---

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

• core/ngcdcs/src/include/ngc/core/ngcdcsEXP.hpp