ngc::core::receivers::TrivialReceiver Class Reference

NGC/NGCII core trivial receiver. More...

#include <trivialReceiver.hpp>

Inheritance diagram for ngc::core::receivers::TrivialReceiver:

Public Member Functions
	TrivialReceiver ()
	Constructor.
virtual	~TrivialReceiver ()
	Destructor.
	TrivialReceiver (TrivialReceiver &)=delete
	Disables unused constructors and operators.
	TrivialReceiver (TrivialReceiver &&)=delete
TrivialReceiver &	operator= (TrivialReceiver &)=delete
virtual int	Open (const char *device_name, char *erms) override
virtual void	Close () override
virtual int	Alloc (unsigned char **buffer, int num, size_t size, char *erms) override
virtual void	Free (unsigned char **buffer, int num) override
virtual int	Start (char *erms) override
virtual int	Stop (char *erms) override
virtual int	Wait (uint64_t *ts, char *erms) override
virtual int	GetStatus (int *err, int *stat, char *erms) override
Public Member Functions inherited from ngc::core::receivers::Receiver
	Receiver ()
	Constructor.
virtual	~Receiver ()
	Destructor.
	Receiver (Receiver &)=delete
	Disables unused constructors and operators.
	Receiver (Receiver &&)=delete
Receiver &	operator= (Receiver &)=delete
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 trivial receiver.

NGC/NGCII core trivial receivers

Constructor & Destructor Documentation

TrivialReceiver() [1/3]

ngc::core::receivers::TrivialReceiver::TrivialReceiver

(

)

Constructor.

~TrivialReceiver()

ngc::core::receivers::TrivialReceiver::~TrivialReceiver ( )

virtual

Destructor.

TrivialReceiver() [2/3]

ngc::core::receivers::TrivialReceiver::TrivialReceiver ( TrivialReceiver & )

delete

Disables unused constructors and operators.

TrivialReceiver() [3/3]

ngc::core::receivers::TrivialReceiver::TrivialReceiver ( TrivialReceiver && )

delete

Member Function Documentation

Alloc()

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

overridevirtual

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

Implements ngc::core::receivers::Receiver.

Close()

void ngc::core::receivers::TrivialReceiver::Close ( )

overridevirtual

Close receiver device

Implements ngc::core::receivers::Receiver.

Free()

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

overridevirtual

Free frame buffers

Parameters

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

Implements ngc::core::receivers::Receiver.

GetStatus()

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

overridevirtual

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

Implements ngc::core::receivers::Receiver.

Open()

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

overridevirtual

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

Implements ngc::core::receivers::Receiver.

operator=()

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

delete

Start()

int ngc::core::receivers::TrivialReceiver::Start ( char * erms )

overridevirtual

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

Implements ngc::core::receivers::Receiver.

Stop()

int ngc::core::receivers::TrivialReceiver::Stop ( char * erms )

overridevirtual

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

Implements ngc::core::receivers::Receiver.

Wait()

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

overridevirtual

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

Implements ngc::core::receivers::Receiver.

---

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

• core/receivers/src/trivialReceiver.hpp
• core/receivers/src/trivialReceiver.cpp