ngcdttIPC Class Reference

#include <ngcdttIPC.hpp>

Inheritance diagram for ngcdttIPC:

Public Member Functions
	ngcdttIPC ()
	Constructor.
	ngcdttIPC (int n)
	Constructor with number of display buffers.
virtual	~ngcdttIPC ()
	Destructor.
int	Configure (const char *name, int nx, int ny)
	Initialize/configure publisher.
void	Shutdown ()
	Shutdown call-back.
int	IdxOut ()
	Return actual display buffer index.
int	IdxIn ()
	Return the buffer index to be used for next transfer.
int	Locked (int idx)
	Check whether the image stored in frame[idx] is locked.
int	Lock (int idx)
	Lock frame[idx].
int	TryLock (int idx)
	Try to lock frame[idx].
int	Unlock (int idx)
	Unlock frame[idx].
int	Wait (int idx)
	Wait until the image stored in frame[idx] is unlocked.
int	Publish (int idx)
	Publish the image stored in frame[idx].
void	Invalidate (int idx)
	Invalidate the image stored in frame[idx].
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

IPC publisher class

Constructor & Destructor Documentation

ngcdttIPC() [1/2]

ngcdttIPC::ngcdttIPC

(

)

Constructor.

ngcdttIPC() [2/2]

ngcdttIPC::ngcdttIPC ( int n )

explicit

Constructor with number of display buffers.

~ngcdttIPC()

ngcdttIPC::~ngcdttIPC ( )

virtual

Destructor.

Member Function Documentation

Configure()

int ngcdttIPC::Configure ( const char * name, int nx, int ny )

virtual

Initialize/configure publisher.

Reimplemented from ngcdttPUBLISH.

IdxIn()

int ngcdttIPC::IdxIn ( )

virtual

Return the buffer index to be used for next transfer.

Reimplemented from ngcdttPUBLISH.

IdxOut()

int ngcdttIPC::IdxOut ( )

virtual

Return actual display buffer index.

Reimplemented from ngcdttPUBLISH.

Invalidate()

void ngcdttIPC::Invalidate ( int idx )

virtual

Invalidate the image stored in frame[idx].

Reimplemented from ngcdttPUBLISH.

Lock()

int ngcdttIPC::Lock ( int idx )

virtual

Lock frame[idx].

Reimplemented from ngcdttPUBLISH.

Locked()

int ngcdttIPC::Locked ( int idx )

virtual

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

Reimplemented from ngcdttPUBLISH.

Publish()

int ngcdttIPC::Publish ( int idx )

virtual

Publish the image stored in frame[idx].

Reimplemented from ngcdttPUBLISH.

Shutdown()

void ngcdttIPC::Shutdown ( )

virtual

Shutdown call-back.

Reimplemented from ngcdttPUBLISH.

TryLock()

int ngcdttIPC::TryLock ( int idx )

virtual

Try to lock frame[idx].

Reimplemented from ngcdttPUBLISH.

Unlock()

int ngcdttIPC::Unlock ( int idx )

virtual

Unlock frame[idx].

Reimplemented from ngcdttPUBLISH.

Wait()

int ngcdttIPC::Wait ( int idx )

virtual

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

Reimplemented from ngcdttPUBLISH.

---

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

• core/ngcdtt/src/include/ngc/core/ngcdttIPC.hpp
• core/ngcdtt/src/ngcdttIPC.cpp