ngc::core::receivers::Acquisition Class Reference

NGC/NGCII core receivers acquisition base class. More...

#include <acquisition.hpp>

Inheritance diagram for ngc::core::receivers::Acquisition:

Public Member Functions
	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 ()

Protected Member Functions
void *	PageAlloc (size_t size)

Detailed Description

NGC/NGCII core receivers acquisition base class.

NGC/NGCII core receivers acquisition base class

Constructor & Destructor Documentation

Acquisition() [1/3]

ngc::core::receivers::Acquisition::Acquisition

(

)

Constructor.

~Acquisition()

ngc::core::receivers::Acquisition::~Acquisition ( )

virtual

Destructor.

Acquisition() [2/3]

ngc::core::receivers::Acquisition::Acquisition ( Acquisition & )

delete

Disables unused constructors and operators.

Acquisition() [3/3]

ngc::core::receivers::Acquisition::Acquisition ( Acquisition && )

delete

Member Function Documentation

GetChannel()

int ngc::core::receivers::Acquisition::GetChannel

(

)

Get receiver channel.

Returns

receiver channel or -1 if no channel is set

GetDoneCnt()

unsigned int ngc::core::receivers::Acquisition::GetDoneCnt

(

)

Get acquisition counter

Returns

aquisition counter

GetJoinerDelay()

unsigned int ngc::core::receivers::Acquisition::GetJoinerDelay

(

)

Get joiner delay. This is the amount of time to wait after a subscription request to ensure that the request came through

Returns

joiner delay in microseconds

GetPayloadSize()

unsigned int ngc::core::receivers::Acquisition::GetPayloadSize

(

)

Get payload size

Returns

payload size in bytes

GetRunning()

bool ngc::core::receivers::Acquisition::GetRunning

(

)

Get running flag

Returns

flag, indicating whether the acquision is running

GetSimulationInterval()

int ngc::core::receivers::Acquisition::GetSimulationInterval

(

)

Get simulation interval (optional use for receiver simulators)

Returns

simulation interval in milliseconds

GetTimeout()

int ngc::core::receivers::Acquisition::GetTimeout

(

)

Get configured timeout to be applied when waiting for next frame buffer.

Returns

timeout in full seconds

GetUnitSize()

unsigned int ngc::core::receivers::Acquisition::GetUnitSize

(

)

Get data unit size

Returns

data unit size in bytes

IncrDoneCnt()

void ngc::core::receivers::Acquisition::IncrDoneCnt

(

)

Increment acquisition counter

IncrDroppedFrames()

void ngc::core::receivers::Acquisition::IncrDroppedFrames

(

)

Increment dropped frames counter

operator=()

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

delete

PageAlloc()

void * ngc::core::receivers::Acquisition::PageAlloc ( size_t size )

protected

Allocate page aligned memory

Parameters

size	Sieze in bytes

Returns

pointer to memory

ReSync()

bool ngc::core::receivers::Acquisition::ReSync

(

)

Get flag, indicating whether or not a re-synchronisation on the next leader packet shall be tried in case packets have been lost

Returns

true if re-synchronisation is permitted

SetCpu()

void ngc::core::receivers::Acquisition::SetCpu

(

int

cpu

)

Propose a CPU to a next level capture thread (e.g. ngcppCapture, ...)

Parameters

cpu	CPU number to assign. Set to zero to prevent further affinity. Set to -1 for automatic assignment.

SetDma()

void ngc::core::receivers::Acquisition::SetDma

(

ngcb_dma_p_t *

dma

)

Attach internal DMA resource

Parameters

dma	Internal DMA resource from API

SetDroppedFrames()

void ngc::core::receivers::Acquisition::SetDroppedFrames

(

unsigned int

cnt

)

Set dropped frames counter

Parameters

cnt	Dropped frames counter

SetRunning()

void ngc::core::receivers::Acquisition::SetRunning

(

bool

flag

)

Set running flag

Parameters

running

Flag, indicating whether the acquision is running

StayInGroup()

bool ngc::core::receivers::Acquisition::StayInGroup

(

)

Get flag, indicating whether or not the receiver should sustain a subscription after stop

Returns

true if the receiver should stay in the subscription group

---

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

• core/receivers/src/include/ngc/core/receivers/acquisition.hpp
• core/receivers/src/acquisition.cpp