ngcdcsACQ_DATA Class Reference

#include <ngcdcsACQ_DATA.hpp>

Inheritance diagram for ngcdcsACQ_DATA:

Public Member Functions
	ngcdcsACQ_DATA ()
	Constructor.
	ngcdcsACQ_DATA (const ngcdcs_acq_cfg_t &cfg)
	Constructor with default configuration.
virtual	~ngcdcsACQ_DATA ()
	Destructor.
void	Configure (const ngcdcs_acq_cfg_t &newConf)
	Overall configuration.
ngcdcs_acq_cfg_t *	Cfg ()
	Get pointer to configuration.
int	Initialize ()
	Intialize data connection.
int	Open ()
	Open data connection ngcppScale(frame);.
int	Close ()
	Close data connection.
int	Kill (int id)
	Kill data client.
int	Fd ()
	Return data connection file descriptor.
int	BitPix (int dataType)
	Convert data type to bitpix-value.
int	FrameDef (ngcdcs_framedef_t *frameDef)
	Currently defined frame types.
int	AvailableFrames ()
	Currently available frame types.
int	FrameType (const char *name)
	Get frame type by frame name.
int	FrameIdx (int ftype)
	Get index for given frame type.
void	FrameName (char *name, int ftype)
	Get frame name by frame type.
void	FrameParam (char *paramName, int ftype)
	Get frame parameter by type.
void	FrameParam (char *paramName, const char *name)
	Get frame parameter by name.
void	SetRequest (int ftype)
	Setup data request (type)
void	SetRequest (int sx, int sy, int nx, int ny)
	Setup data request (window)
void	SetRequest (int ftype, int sx, int sy, int nx, int ny)
	Setup data request (all)
int	Request ()
	Send data request (same request again)
int	Request (int ftype)
	Send data request (new type)
int	Request (int sx, int sy, int nx, int ny)
	Send data request (new window)
int	Request (int ftype, int sx, int sy, int nx, int ny)
	Send data request (all new)
int	Retransmit ()
	Retransmit frame (same)
int	Retransmit (int sx, int sy, int nx, int ny)
	retransmit frame (new window)
int	Cancel ()
	Cancel pending data request.
int	Wait ()
	Wait for data event.
int	Skip ()
	Skip data frame.
int	GetFrame (void *buffer, int chipPid=0)
	Get frame as it is.
int	GetFrame (void *buffer, int sx, int sy, int nx, int ny, int chipId=0)
	Get frame (new window)
int	GetFrame (ngcpp_frame_t *frame, int chipId=0)
	Get frame as it is.
int	GetFrame (ngcpp_frame_t *frame, int sx, int sy, int nx, int ny, int chipId=0)
	Get frame (new window)
int	Accept (int flags=0)
	Accept data frame (as is)
int	Accept (int sx, int sy, int nx, int ny, int flags=0)
	Accept data frame (new window)
int	Receive (void *buffer, size_t offset, size_t size)
	Receive frame data.
int	Receive (ngcpp_frame_t *frame, size_t offset, size_t size)
	Receive frame data.
void	Scale (ngcpp_frame_t *frame)
	Apply scale factor.
void	Scale (void *buffer, int nx, int ny, int *dataType, int *divisor)
	Apply scale factor.
void	Scale (void *buffer, ngcdcs_finfo_t *f)
	Apply scale factor.
void	Scale (void *buffer)
	Apply scale factor.
void	Cv16 (void *buffer)
	Convert to 16 bit signed.
void	Cv16 (void *buffer, ngcdcs_finfo_t *f)
	Convert to 16 bit signed.
int	Valid ()
	Valid frame received.
int	FrameType ()
	Get current frame type.
int	FrameIdx ()
	Get index for current frame type.
void	FrameName (char *)
	Get current frame name.
int	DataType ()
	Return data type.
int	Divisor ()
	Return frame Divisor.
int	BZERO ()
	Return frame BZERO.
double	ExpFactor ()
	Return factor for EXPTIME.
int	FrameCounter ()
	Return frame counter.
int	FrameCounter0 ()
	Return frame counter start value.
int	SetupId ()
	Return setup-id.
int	StartX ()
	Return start pixel in x-direction.
int	StartY ()
	Return start pixel in y-direction.
int	NX ()
	Return x-dimension.
int	NY ()
	Return y-dimension.
int	Error ()
	Return error code.
size_t	NumPix ()
	Return number of pixels in frame.
size_t	FrameSize ()
	Return frame size in bytes.
int	DatumSize ()
	Return pixel datum size in bytes.
int	BitPix ()
	Return current bitpix-value.
double	TimeStamp ()
	Return MUDPI/RTMS timestamp (seconds since UNIX epoch)
int	Transferring ()
	Return transferring flag.
int	Term ()
	Return termination flag.
int	AppDataSize ()
	Return application data size.
char *	AppData ()
	Return pointer to application data.
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
int	ioError
	Flag for io-error.
int	numDet
	Number of detectors in mosaic.
int	protocolVersion
	Protocol version.
int	scale2float
	Aways scale 32-bit integer to float.
Public Attributes inherited from ngcbOBJ
FILE *	watchdog
	Watchdog stream.
ngcbALARM_SYS *	alarmSystem
	Alarm system.
ngcbSERVICE *	services
	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.

Additional Inherited Members
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.
virtual void virtual void virtual void virtual void virtual void void virtual void	SendFeedBack (const char *msg)
	Feed-back sender implementation.
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

Acquisition process data interface class

Constructor & Destructor Documentation

ngcdcsACQ_DATA() [1/2]

ngcdcsACQ_DATA::ngcdcsACQ_DATA

(

)

Constructor.

ngcdcsACQ_DATA() [2/2]

ngcdcsACQ_DATA::ngcdcsACQ_DATA ( const ngcdcs_acq_cfg_t & cfg )

explicit

Constructor with default configuration.

~ngcdcsACQ_DATA()

ngcdcsACQ_DATA::~ngcdcsACQ_DATA ( )

virtual

Destructor.

Member Function Documentation

Accept() [1/2]

int ngcdcsACQ_DATA::Accept

(

int

flags = 0

)

Accept data frame (as is)

Accept() [2/2]

int ngcdcsACQ_DATA::Accept	(	int	sx,
		int	sy,
		int	nx,
		int	ny,
		int	flags = 0 )

Accept data frame (new window)

AppData()

char * ngcdcsACQ_DATA::AppData

(

)

Return pointer to application data.

AppDataSize()

int ngcdcsACQ_DATA::AppDataSize

(

)

Return application data size.

AvailableFrames()

int ngcdcsACQ_DATA::AvailableFrames

(

)

Currently available frame types.

BitPix() [1/2]

int ngcdcsACQ_DATA::BitPix

(

)

Return current bitpix-value.

BitPix() [2/2]

int ngcdcsACQ_DATA::BitPix

(

int

dataType

)

Convert data type to bitpix-value.

BZERO()

int ngcdcsACQ_DATA::BZERO

(

)

Return frame BZERO.

Cancel()

int ngcdcsACQ_DATA::Cancel

(

)

Cancel pending data request.

Cfg()

ngcdcs_acq_cfg_t * ngcdcsACQ_DATA::Cfg

(

)

Get pointer to configuration.

Close()

int ngcdcsACQ_DATA::Close

(

)

Close data connection.

Configure()

void ngcdcsACQ_DATA::Configure

(

const ngcdcs_acq_cfg_t &

newConf

)

Overall configuration.

Cv16() [1/2]

void ngcdcsACQ_DATA::Cv16

(

void *

buffer

)

Convert to 16 bit signed.

Cv16() [2/2]

void ngcdcsACQ_DATA::Cv16	(	void *	buffer,
		ngcdcs_finfo_t *	f )

Convert to 16 bit signed.

DataType()

int ngcdcsACQ_DATA::DataType

(

)

Return data type.

DatumSize()

int ngcdcsACQ_DATA::DatumSize

(

)

Return pixel datum size in bytes.

Divisor()

int ngcdcsACQ_DATA::Divisor

(

)

Return frame Divisor.

Error()

int ngcdcsACQ_DATA::Error

(

)

Return error code.

ExpFactor()

double ngcdcsACQ_DATA::ExpFactor

(

)

Return factor for EXPTIME.

Fd()

int ngcdcsACQ_DATA::Fd

(

)

Return data connection file descriptor.

FrameCounter()

int ngcdcsACQ_DATA::FrameCounter

(

)

Return frame counter.

FrameCounter0()

int ngcdcsACQ_DATA::FrameCounter0

(

)

Return frame counter start value.

FrameDef()

int ngcdcsACQ_DATA::FrameDef

(

ngcdcs_framedef_t *

frameDef

)

Currently defined frame types.

FrameIdx() [1/2]

int ngcdcsACQ_DATA::FrameIdx

(

)

Get index for current frame type.

FrameIdx() [2/2]

int ngcdcsACQ_DATA::FrameIdx

(

int

ftype

)

Get index for given frame type.

FrameName() [1/2]

void ngcdcsACQ_DATA::FrameName

(

char *

name

)

Get current frame name.

FrameName() [2/2]

void ngcdcsACQ_DATA::FrameName	(	char *	name,
		int	ftype )

Get frame name by frame type.

FrameParam() [1/2]

void ngcdcsACQ_DATA::FrameParam	(	char *	paramName,
		const char *	name )

Get frame parameter by name.

FrameParam() [2/2]

void ngcdcsACQ_DATA::FrameParam	(	char *	paramName,
		int	ftype )

Get frame parameter by type.

FrameSize()

size_t ngcdcsACQ_DATA::FrameSize

(

)

Return frame size in bytes.

FrameType() [1/2]

int ngcdcsACQ_DATA::FrameType

(

)

Get current frame type.

FrameType() [2/2]

int ngcdcsACQ_DATA::FrameType

(

const char *

name

)

Get frame type by frame name.

GetFrame() [1/4]

int ngcdcsACQ_DATA::GetFrame	(	ngcpp_frame_t *	frame,
		int	chipId = 0 )

Get frame as it is.

GetFrame() [2/4]

int ngcdcsACQ_DATA::GetFrame	(	ngcpp_frame_t *	frame,
		int	sx,
		int	sy,
		int	nx,
		int	ny,
		int	chipId = 0 )

Get frame (new window)

GetFrame() [3/4]

int ngcdcsACQ_DATA::GetFrame	(	void *	buffer,
		int	chipPid = 0 )

Get frame as it is.

GetFrame() [4/4]

int ngcdcsACQ_DATA::GetFrame	(	void *	buffer,
		int	sx,
		int	sy,
		int	nx,
		int	ny,
		int	chipId = 0 )

Get frame (new window)

Initialize()

int ngcdcsACQ_DATA::Initialize

(

)

Intialize data connection.

Kill()

int ngcdcsACQ_DATA::Kill

(

int

id

)

Kill data client.

NumPix()

size_t ngcdcsACQ_DATA::NumPix

(

)

Return number of pixels in frame.

NX()

int ngcdcsACQ_DATA::NX

(

)

Return x-dimension.

NY()

int ngcdcsACQ_DATA::NY

(

)

Return y-dimension.

Open()

int ngcdcsACQ_DATA::Open

(

)

Open data connection ngcppScale(frame);.

Receive() [1/2]

int ngcdcsACQ_DATA::Receive	(	ngcpp_frame_t *	frame,
		size_t	offset,
		size_t	size )

Receive frame data.

Receive() [2/2]

int ngcdcsACQ_DATA::Receive	(	void *	buffer,
		size_t	offset,
		size_t	size )

Receive frame data.

Request() [1/4]

int ngcdcsACQ_DATA::Request

(

)

Send data request (same request again)

Request() [2/4]

int ngcdcsACQ_DATA::Request

(

int

ftype

)

Send data request (new type)

Request() [3/4]

int ngcdcsACQ_DATA::Request	(	int	ftype,
		int	sx,
		int	sy,
		int	nx,
		int	ny )

Send data request (all new)

Request() [4/4]

int ngcdcsACQ_DATA::Request	(	int	sx,
		int	sy,
		int	nx,
		int	ny )

Send data request (new window)

Retransmit() [1/2]

int ngcdcsACQ_DATA::Retransmit

(

)

Retransmit frame (same)

Retransmit() [2/2]

int ngcdcsACQ_DATA::Retransmit	(	int	sx,
		int	sy,
		int	nx,
		int	ny )

retransmit frame (new window)

Scale() [1/4]

void ngcdcsACQ_DATA::Scale

(

ngcpp_frame_t *

frame

)

Apply scale factor.

Scale() [2/4]

void ngcdcsACQ_DATA::Scale

(

void *

buffer

)

Apply scale factor.

Scale() [3/4]

void ngcdcsACQ_DATA::Scale	(	void *	buffer,
		int	nx,
		int	ny,
		int *	dataType,
		int *	divisor )

Apply scale factor.

Scale() [4/4]

void ngcdcsACQ_DATA::Scale	(	void *	buffer,
		ngcdcs_finfo_t *	f )

Apply scale factor.

SetRequest() [1/3]

void ngcdcsACQ_DATA::SetRequest

(

int

ftype

)

Setup data request (type)

SetRequest() [2/3]

void ngcdcsACQ_DATA::SetRequest	(	int	ftype,
		int	sx,
		int	sy,
		int	nx,
		int	ny )

Setup data request (all)

SetRequest() [3/3]

void ngcdcsACQ_DATA::SetRequest	(	int	sx,
		int	sy,
		int	nx,
		int	ny )

Setup data request (window)

SetupId()

int ngcdcsACQ_DATA::SetupId

(

)

Return setup-id.

Skip()

int ngcdcsACQ_DATA::Skip

(

)

Skip data frame.

StartX()

int ngcdcsACQ_DATA::StartX

(

)

Return start pixel in x-direction.

StartY()

int ngcdcsACQ_DATA::StartY

(

)

Return start pixel in y-direction.

Term()

int ngcdcsACQ_DATA::Term

(

)

Return termination flag.

TimeStamp()

double ngcdcsACQ_DATA::TimeStamp

(

)

Return MUDPI/RTMS timestamp (seconds since UNIX epoch)

Transferring()

int ngcdcsACQ_DATA::Transferring

(

)

Return transferring flag.

Valid()

int ngcdcsACQ_DATA::Valid

(

)

Valid frame received.

Wait()

int ngcdcsACQ_DATA::Wait

(

)

Wait for data event.

Member Data Documentation

ioError

int ngcdcsACQ_DATA::ioError

Flag for io-error.

numDet

int ngcdcsACQ_DATA::numDet

Number of detectors in mosaic.

protocolVersion

int ngcdcsACQ_DATA::protocolVersion

Protocol version.

scale2float

int ngcdcsACQ_DATA::scale2float

Aways scale 32-bit integer to float.

---

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

• core/ngcdcs/src/include/ngc/core/ngcdcsACQ_DATA.hpp
• core/ngcdcs/src/ngcdcsACQ_DATA.cpp