doc/sdk/_pv_tap_filter_8h_source.html

 // *****************************************************************************

 //

 //     Copyright (c) 2015, Pleora Technologies Inc., All rights reserved.

 //

 // *****************************************************************************


 #ifndef __PVTAPFILTER_H__

 #define __PVTAPFILTER_H__


 #include <IPvFilter.h>

 #include <PvTapGeometry.h>


 class TapFilter;


 class PV_BUFFER_API PvTapFilter : public IPvFilter

 {

 public:


     PvTapFilter();


     virtual ~PvTapFilter();


     PvResult Execute( const PvBuffer *aIn, PvBuffer *aOut );


     PvResult SetThreadCount( uint32_t aCount );


     uint32_t GetThreadCount() const;


     PvResult GetThreadsPriority( uint32_t &aPriority ) const;

     PvResult SetThreadsPriority( uint32_t aPriority );


     PvResult SetGeometry( PvTapGeometryEnum aValue );


     PvTapGeometryEnum GetGeometry() const;


     static uint32_t GetSupportedGeometryCount();


     static PvTapGeometryEnum GetSupportedGeometryValue( uint32_t aIndex );


     static const PvString &GetSupportedGeometryName( uint32_t aIndex );


     static PvPixelType GetOutputPixelTypeFor( const PvBuffer *aBuffer );


     static uint32_t GetTapCountFor( PvTapGeometryEnum aValue );


     static uint32_t GetTapCountFor( const PvString &aValue );


 protected:


 private:


     // Not implemented

     PvTapFilter( const PvTapFilter & );

     const PvTapFilter &operator=( const PvTapFilter & );


     TapFilter * mThis;


 };


 #endif

PvPixelType
PvPixelType
Definition: PvPixelType.h:58

PvTapGeometry.h
Tap geometry types definition.

PvTapGeometryEnum
PvTapGeometryEnum
Tap geoemtry enumeration type.
Definition: PvTapGeometry.h:117

IPvFilter
Definition: IPvFilter.h:19

IPvFilter::Execute
virtual PvResult Execute(const PvBuffer *aIn, PvBuffer *aOut)=0
Executes the filter: performs processing on aIn, writing into aOut.

IPvFilter::GetThreadCount
virtual uint32_t GetThreadCount() const =0
Gets the maximum number of threads the filter can use.

IPvFilter::SetThreadCount
virtual PvResult SetThreadCount(uint32_t aCount)=0
Sets the thread count to be used by the filter.

IPvFilter::GetThreadsPriority
virtual PvResult GetThreadsPriority(uint32_t &aPriority) const =0
Gets the thread priority of the filter's worker threads.

IPvFilter::SetThreadsPriority
virtual PvResult SetThreadsPriority(uint32_t aPriority)=0
Sets the thread priority of the filter's worker threads.

PvBuffer
Represents a block of GigE Vision or USB3 Vision data in memory.
Definition: PvBuffer.h:97

PvResult
Result information.
Definition: PvResult.h:30

PvString
String class.
Definition: PvString.h:26

PvTapFilter
Definition: PvTapFilter.h:22