ngcppAPP Class Reference

NCG pre-processor application class. More...

#include <ngcppAPP.hpp>

Inheritance diagram for ngcppAPP:

Public Member Functions
	ngcppAPP ()
	Application constructor.
virtual	~ngcppAPP ()
	Destructor.
virtual int	Configure (char *erms)
	Configuration call-back.
virtual int	Connect (const char *name, char *erms)
	Connect to camera.
virtual int	Disconnect (char *erms)
	Disconnect from camera.
virtual int	Alloc (unsigned char **buffer, int n, size_t size, char *erms)
	Allocate circular buffer.
virtual void	Free (unsigned char **buffer, int n)
	Free circular buffer.
virtual int	Clear (char *erms)
	Clear data fifos.
virtual int	StartAcquisition (char *erms)
	Start image acquisition.
virtual int	StopAcquisition (char *erms)
	Stop image acquisition.
virtual void	SkipData ()
	Skip next data buffer.
virtual int	NextData (unsigned char *buffer, size_t size, uint64_t *ts, char *erms)
	Get next data buffer from camera.
virtual int	Process (int instance, void *buffer, char *erms)
	Process data (multithreaded, if numProc is greater than 1)
virtual void	Publish ()
	Publisher call-back, executed after all data-processes have finished.
virtual void	ResetCounters (int cnt)
	Call-back to reset the application counters.
virtual int	CheckParam (int *param, int running, int *idx)
	Check parameter range.
virtual void	Command (const char *command, char *reply)
	Command handler.
virtual void	AppStart ()
	Enter main loop callback.
int	RunApp (int argc, char **argv, char *erms)
	Run the application.
void	TerminateProcesses ()
	Terminate application processes.
void	AddLog (const char *msg)
	Add a message to the logging service.
void	Failure (const char *msg)
	Signal error condition.
void	FailureOverrun (const char *msg)
	Signal buffer overrun (error condition)

Public Attributes
int	nx
	x-dimension
int	ny
	y-dimension
int	numProc
	Number of processors.
int	skipData
	Enable data-skip call-back.
ngcbSEM *	semData
	Counting data buffer semaphore.
bool	mainLoopRunning
	Main loop is running.

Detailed Description

NCG pre-processor application class.

Constructor & Destructor Documentation

ngcppAPP()

ngcppAPP::ngcppAPP

(

)

Application constructor.

~ngcppAPP()

ngcppAPP::~ngcppAPP ( )

virtual

Destructor.

Member Function Documentation

AddLog()

void ngcppAPP::AddLog

(

const char *

msg

)

Add a message to the logging service.

Alloc()

int ngcppAPP::Alloc ( unsigned char ** buffer, int n, size_t size, char * erms )

virtual

Allocate circular buffer.

AppStart()

void ngcppAPP::AppStart ( )

virtual

Enter main loop callback.

Reimplemented in TEST_APP.

CheckParam()

int ngcppAPP::CheckParam ( int * param, int running, int * idx )

virtual

Check parameter range.

Reimplemented in TEST_APP.

Clear()

int ngcppAPP::Clear ( char * erms )

virtual

Clear data fifos.

Reimplemented in TEST_APP.

Command()

void ngcppAPP::Command ( const char * command, char * reply )

virtual

Command handler.

Reimplemented in TEST_APP.

Configure()

int ngcppAPP::Configure ( char * erms )

virtual

Configuration call-back.

Reimplemented in TEST_APP.

Connect()

int ngcppAPP::Connect ( const char * name, char * erms )

virtual

Connect to camera.

Reimplemented in TEST_APP.

Disconnect()

int ngcppAPP::Disconnect ( char * erms )

virtual

Disconnect from camera.

Reimplemented in TEST_APP.

Failure()

void ngcppAPP::Failure

(

const char *

msg

)

Signal error condition.

FailureOverrun()

void ngcppAPP::FailureOverrun

(

const char *

msg

)

Signal buffer overrun (error condition)

Free()

void ngcppAPP::Free ( unsigned char ** buffer, int n )

virtual

Free circular buffer.

NextData()

int ngcppAPP::NextData ( unsigned char * buffer, size_t size, uint64_t * ts, char * erms )

virtual

Get next data buffer from camera.

Reimplemented in TEST_APP.

Process()

int ngcppAPP::Process ( int instance, void * buffer, char * erms )

virtual

Process data (multithreaded, if numProc is greater than 1)

Reimplemented in TEST_APP.

Publish()

void ngcppAPP::Publish ( )

virtual

Publisher call-back, executed after all data-processes have finished.

Reimplemented in TEST_APP.

ResetCounters()

void ngcppAPP::ResetCounters ( int cnt )

virtual

Call-back to reset the application counters.

Reimplemented in TEST_APP.

RunApp()

int ngcppAPP::RunApp	(	int	argc,
		char **	argv,
		char *	erms )

Run the application.

SkipData()

void ngcppAPP::SkipData ( )

virtual

Skip next data buffer.

Reimplemented in TEST_APP.

StartAcquisition()

int ngcppAPP::StartAcquisition ( char * erms )

virtual

Start image acquisition.

Reimplemented in TEST_APP.

StopAcquisition()

int ngcppAPP::StopAcquisition ( char * erms )

virtual

Stop image acquisition.

Reimplemented in TEST_APP.

TerminateProcesses()

void ngcppAPP::TerminateProcesses

(

)

Terminate application processes.

Member Data Documentation

mainLoopRunning

bool ngcppAPP::mainLoopRunning

Main loop is running.

numProc

int ngcppAPP::numProc

Number of processors.

nx

int ngcppAPP::nx

x-dimension

ny

int ngcppAPP::ny

y-dimension

semData

ngcbSEM* ngcppAPP::semData

Counting data buffer semaphore.

skipData

int ngcppAPP::skipData

Enable data-skip call-back.

---

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

• core/ngcppAPP/src/include/ngc/core/ngcppAPP.hpp
• core/ngcppAPP/src/ngcppAPP.cpp