ngc::gateway::ddt::Publisher Class Reference

NGC/NGCII gateway publisher class for DDT. More...

#include <pub.hpp>

Inheritance diagram for ngc::gateway::ddt::Publisher:

Public Member Functions
	Publisher (std::mutex &m, ::ddt::DdtLogger *logger=nullptr)
	Publisher (std::mutex &m, int n, ::ddt::DdtLogger *logger=nullptr)
virtual	~Publisher ()
	Destructor.
	Publisher (Publisher &)=delete
	Disables unused constructors and operators.
	Publisher (Publisher &&)=delete
Publisher &	operator= (Publisher &)=delete
virtual int	Configure (const char *name, int nx, int ny) override
virtual void	Shutdown () override
	Shutdown callback.
virtual int	IdxOut () override
virtual int	IdxIn () override
virtual int	Locked (int idx) override
virtual int	Lock (int idx) override
virtual int	TryLock (int idx) override
virtual int	Unlock (int idx) override
virtual int	Wait (int idx) override
virtual int	Publish (int idx) override
virtual void	Invalidate (int idx) override
Public Member Functions inherited from ngcdttPUBLISH
	ngcdttPUBLISH ()
	Constructor.
	ngcdttPUBLISH (int n)
	Constructor with number of display buffers.
virtual	~ngcdttPUBLISH ()
	Destructor.
char *	ErrMsg ()
	Return actual error message.
const char *	Type ()
	Return display type.
int	BytesPerPix (int dataType)
	Return number of bytes per pixel for specific data type.
int	Size (ngcpp_hdr_t hdr)
	Compute frame size in bytes.
int	NumBuf ()
	Return number of available display buffers.
void	NumBuf (int n)
	Set new number of display buffers.
ngcdtt_frame_t *	Frame ()
	Get current frame slot.
int	Publish ()
	Publish current frame buffer.
int	TryLock ()
	Try to lock current frame bbuffer.
int	Lock ()
	Lock current frame buffer.
int	Unlock ()
	Unlock current frame buffer.
void	Invalidate ()
	Invalidate current frame buffer.

Additional Inherited Members
Public Attributes inherited from ngcdttPUBLISH
int	initialized
	Initialized (flag)
char	uri [256]
	URI, if applicable.
int	frameId
	Unique frame-id for display.
ngcdtt_frame_t *	frame
	Frames array.
Protected Member Functions inherited from ngcdttPUBLISH
void	Type (const char *name)

Detailed Description

NGC/NGCII gateway publisher class for DDT.

NGC/NGCII gateway publisher class for DDT

Constructor & Destructor Documentation

Publisher() [1/4]

ngc::gateway::ddt::Publisher::Publisher ( std::mutex & m, ::ddt::DdtLogger * logger = nullptr )

explicit

Constructor

Parameters

m	DDT protection mutex
logger	DDT logger

Publisher() [2/4]

ngc::gateway::ddt::Publisher::Publisher ( std::mutex & m, int n, ::ddt::DdtLogger * logger = nullptr )

explicit

Constructor

Parameters

m	DDT protection mutex
n	Number of display buffers
logger	DDT logger

~Publisher()

ngc::gateway::ddt::Publisher::~Publisher ( )

virtual

Destructor.

Publisher() [3/4]

ngc::gateway::ddt::Publisher::Publisher ( Publisher & )

delete

Disables unused constructors and operators.

Publisher() [4/4]

ngc::gateway::ddt::Publisher::Publisher ( Publisher && )

delete

Member Function Documentation

Configure()

int ngc::gateway::ddt::Publisher::Configure ( const char * name, int nx, int ny )

overridevirtual

Configure publisher

Parameters

name	Datastream name
nx	Maximum x-dimension
ny	Maximum y-dimension

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

IdxIn()

int ngc::gateway::ddt::Publisher::IdxIn ( )

overridevirtual

Buffer index to be used for next transfer

Returns

the buffer index to be used for next transfer

Reimplemented from ngcdttPUBLISH.

IdxOut()

int ngc::gateway::ddt::Publisher::IdxOut ( )

overridevirtual

Actual display buffer index

Returns

actual display buffer index

Reimplemented from ngcdttPUBLISH.

Invalidate()

void ngc::gateway::ddt::Publisher::Invalidate ( int idx )

overridevirtual

Invalidate the image stored in frame[idx]

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

Lock()

int ngc::gateway::ddt::Publisher::Lock ( int idx )

overridevirtual

Lock frame[idx]

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

Locked()

int ngc::gateway::ddt::Publisher::Locked ( int idx )

overridevirtual

Check whether the image stored in frame[idx] is locked

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

operator=()

Publisher & ngc::gateway::ddt::Publisher::operator= ( Publisher & )

delete

Publish()

int ngc::gateway::ddt::Publisher::Publish ( int idx )

overridevirtual

Publish the image stored in frame[idx]

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

Shutdown()

void ngc::gateway::ddt::Publisher::Shutdown ( )

overridevirtual

Shutdown callback.

Reimplemented from ngcdttPUBLISH.

TryLock()

int ngc::gateway::ddt::Publisher::TryLock ( int idx )

overridevirtual

Try to lock frame[idx]

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

Unlock()

int ngc::gateway::ddt::Publisher::Unlock ( int idx )

overridevirtual

Unlock frame[idx]

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

Wait()

int ngc::gateway::ddt::Publisher::Wait ( int idx )

overridevirtual

Wait until the image stored in frame[idx] is unlocked

Parameters

idx	Frame index

Returns

ngcbSUCCESS in case of success, ngcbFAILURE otherwise

Reimplemented from ngcdttPUBLISH.

---

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

• gateway/ddt/pub/src/include/ngc/gateway/ddt/pub.hpp
• gateway/ddt/pub/src/pub.cpp