Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



Public Member Functions | List of all members
IPvFilter Class Referenceabstract

#include <IPvFilter.h>

Public Member Functions

 IPvFilter ()
 Constructor.
 
virtual ~IPvFilter ()
 Destructor.
 
virtual PvResult Execute (const PvBuffer *aIn, PvBuffer *aOut)=0
 Executes the filter: performs processing on aIn, writing into aOut. More...
 
virtual PvResult SetThreadCount (uint32_t aCount)=0
 Sets the thread count to be used by the filter. More...
 
virtual uint32_t GetThreadCount () const =0
 Gets the maximum number of threads the filter can use. More...
 
virtual PvResult GetThreadsPriority (uint32_t &aPriority) const =0
 Gets the thread priority of the filter's worker threads. More...
 
virtual PvResult SetThreadsPriority (uint32_t aPriority)=0
 Sets the thread priority of the filter's worker threads. More...
 

Detailed Description

Base class (interface) of various processing filters provided by the eBUS SDK.

Member Function Documentation

◆ Execute()

virtual PvResult IPvFilter::Execute ( const PvBuffer *  aIn,
PvBuffer *  aOut 
)
pure virtual

Executes the filter: performs processing on aIn, writing into aOut.

Parameters
[in]aInThe input buffer where data is read from.
[out]aOutThe output buffer where data is written to.

Implemented in PvDecompressionFilter, PvCompressionFilter, and PvTapFilter.

◆ GetThreadCount()

virtual uint32_t IPvFilter::GetThreadCount ( ) const
pure virtual

Gets the maximum number of threads the filter can use.

Returns
The maximum number of threads the filter can use.

Implemented in PvDecompressionFilter, PvTapFilter, and PvCompressionFilter.

◆ GetThreadsPriority()

virtual PvResult IPvFilter::GetThreadsPriority ( uint32_t &  aPriority) const
pure virtual

Gets the thread priority of the filter's worker threads.

Parameters
aPriority[out] Output reference to the worker threads priority.
Returns
Includes:

Implemented in PvDecompressionFilter, PvCompressionFilter, and PvTapFilter.

◆ SetThreadCount()

virtual PvResult IPvFilter::SetThreadCount ( uint32_t  aCount)
pure virtual

Sets the thread count to be used by the filter.

Parameters
[in]aCountThe maximum number of threads that can be used by this filter.
Returns
Includes:

Implemented in PvDecompressionFilter, PvTapFilter, and PvCompressionFilter.

◆ SetThreadsPriority()

virtual PvResult IPvFilter::SetThreadsPriority ( uint32_t  aPriority)
pure virtual

Sets the thread priority of the filter's worker threads.

Returns
Includes:

Implemented in PvDecompressionFilter, PvCompressionFilter, and PvTapFilter.

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

Copyright (c) 2002-2024 Pleora Technologies Inc.
www.pleora.com