DUNE: Uniform Navigational Environment  2019.02.0
Vision::DFK51BG02H::GVSP Class Reference

Detailed Description

GigE Vision Stream Protocol (GVSP).

Public Member Functions

 GVSP (DUNE::Tasks::Task *task, uint16_t port, unsigned buffer_capacity=16384)
 
 ~GVSP (void)
 
void enqueueDirty (Frame *frame)
 
FramedequeueDirty (void)
 
void waitDirty (double timeout)
 
void enqueueClean (Frame *frame)
 
FramedequeueClean (void)
 

Constructor & Destructor Documentation

Vision::DFK51BG02H::GVSP::GVSP ( DUNE::Tasks::Task task,
uint16_t  port,
unsigned  buffer_capacity = 16384 
)
inline

Constructor.

Parameters
[in]taskparent task.
[in]portUDP listening port.
[in]buffer_capacitypacket buffer capacity.
Vision::DFK51BG02H::GVSP::~GVSP ( void  )
inline

Destructor.

Member Function Documentation

Frame* Vision::DFK51BG02H::GVSP::dequeueClean ( void  )
inline

Dequeue clean frame.

Returns
clean frame or NULL if none is available.
Frame* Vision::DFK51BG02H::GVSP::dequeueDirty ( void  )
inline

Dequeue dirty frame.

Returns
frame dirty frame or NULL if none is available.

Referenced by Vision::DFK51BG02H::Task::onMain().

void Vision::DFK51BG02H::GVSP::enqueueClean ( Frame frame)
inline

Enqueue clean frame.

Parameters
[in]frameclean frame.

Referenced by Vision::DFK51BG02H::Task::onMain(), and Vision::DFK51BG02H::Task::onResourceAcquisition().

void Vision::DFK51BG02H::GVSP::enqueueDirty ( Frame frame)
inline

Enqueue dirty frame.

Parameters
[in]framedirty frame.
void Vision::DFK51BG02H::GVSP::waitDirty ( double  timeout)
inline

Wait for a dirty frame to be available.

Parameters
[in]timeoutmaximum amount of time to wait.

Referenced by Vision::DFK51BG02H::Task::onMain().

Collaboration diagram for Vision::DFK51BG02H::GVSP:
Collaboration graph