ngc::core::receivers::Receiver Class Reference

NGC/NGCII core receiver bridge class. More...

#include <receiver.hpp>

Inheritance diagram for ngc::core::receivers::Receiver:

Public Member Functions
	Receiver ()
	Constructor.
virtual	~Receiver ()
	Destructor.
	Receiver (Receiver &)=delete
	Disables unused constructors and operators.
	Receiver (Receiver &&)=delete
Receiver &	operator= (Receiver &)=delete
virtual int	Open (const char *device_name, char *erms)=0
virtual void	Close ()=0
virtual int	Alloc (unsigned char **buffer, int num, size_t size, char *erms)=0
virtual void	Free (unsigned char **buffer, int num)=0
virtual int	Start (char *erms)=0
virtual int	Stop (char *erms)=0
virtual int	Wait (uint64_t *ts, char *erms)=0
virtual int	GetStatus (int *err, int *stat, char *erms)=0
Public Member Functions inherited from ngc::core::receivers::Acquisition
	Acquisition ()
	Constructor.
virtual	~Acquisition ()
	Destructor.
	Acquisition (Acquisition &)=delete
	Disables unused constructors and operators.
	Acquisition (Acquisition &&)=delete
Acquisition &	operator= (Acquisition &)=delete
void	SetDma (ngcb_dma_p_t *dma)
unsigned int	GetDoneCnt ()
void	IncrDoneCnt ()
void	SetRunning (bool flag)
bool	GetRunning ()
void	SetCpu (int cpu)
void	SetDroppedFrames (unsigned int cnt)
void	IncrDroppedFrames ()
unsigned int	GetPayloadSize ()
unsigned int	GetUnitSize ()
int	GetTimeout ()
int	GetSimulationInterval ()
int	GetChannel ()
unsigned int	GetJoinerDelay ()
bool	ReSync ()
bool	StayInGroup ()

Additional Inherited Members
Protected Member Functions inherited from ngc::core::receivers::Acquisition
void *	PageAlloc (size_t size)

Detailed Description

NGC/NGCII core receiver bridge class.

NGC/NGCII core receivers bridge class

Constructor & Destructor Documentation

Receiver() [1/3]

ngc::core::receivers::Receiver::Receiver ( )

inline

Constructor.

~Receiver()

virtual ngc::core::receivers::Receiver::~Receiver ( )

inlinevirtual

Destructor.

Receiver() [2/3]

ngc::core::receivers::Receiver::Receiver ( Receiver & )

delete

Disables unused constructors and operators.

Receiver() [3/3]

ngc::core::receivers::Receiver::Receiver ( Receiver && )

delete

Member Function Documentation

Alloc()

virtual int ngc::core::receivers::Receiver::Alloc ( unsigned char ** buffer, int num, size_t size, char * erms )

pure virtual

Allocate frame buffers

Parameters

buffer	Array of frame buffers
num	Number of frame buffers in the array
size	Size of each buffer in bytes
erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

Close()

virtual void ngc::core::receivers::Receiver::Close ( )

pure virtual

Close receiver device

Implemented in ngc::core::receivers::TrivialReceiver.

Free()

virtual void ngc::core::receivers::Receiver::Free ( unsigned char ** buffer, int num )

pure virtual

Free frame buffers

Parameters

buffer	Array of frame buffers
num	Number of frame buffers in the array

Implemented in ngc::core::receivers::TrivialReceiver.

GetStatus()

virtual int ngc::core::receivers::Receiver::GetStatus ( int * err, int * stat, char * erms )

pure virtual

Get acquisition status

Parameters

err	Error status (like errno, set to zero for no error)
stat	Receiver statua
erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

Open()

virtual int ngc::core::receivers::Receiver::Open ( const char * device_name, char * erms )

pure virtual

Open receiver device

Parameters

device_name	name of the device (including configuration tags)
erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

operator=()

Receiver & ngc::core::receivers::Receiver::operator= ( Receiver & )

delete

Start()

virtual int ngc::core::receivers::Receiver::Start ( char * erms )

pure virtual

Start acquisition

Parameters

erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

Stop()

virtual int ngc::core::receivers::Receiver::Stop ( char * erms )

pure virtual

Stop acquisition

Parameters

erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

Wait()

virtual int ngc::core::receivers::Receiver::Wait ( uint64_t * ts, char * erms )

pure virtual

Wait for next frame buffer

Parameters

ts	Timestamp to be set (seconds since unix epoch)
erms	Error message to be filled in case of error

Returns

zero in case of success or -1 if the operation failed

Implemented in ngc::core::receivers::TrivialReceiver.

---

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

• core/receivers/src/include/ngc/core/receivers/receiver.hpp