Class IPvFilter

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

Inheritance

object

IPvFilter

PvCompressionFilter

PvDecompressionFilter

PvTapFilter

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class IPvFilter : IDisposable

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

ThreadCount

ThreadCount property of IPvFilter.

Declaration

public virtual uint ThreadCount { get; set; }

Property Value

Type	Description
uint

Methods

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Execute(PvBuffer, ref PvBuffer)

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

Declaration

public virtual PvResult Execute(PvBuffer aIn, ref PvBuffer aOut)

Parameters

Type	Name	Description
PvBuffer	aIn	The input buffer where data is read from.
PvBuffer	aOut	The output buffer where data is written to.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK - #PvResult::Code::INVALID_PARAMETER if aIn or aOut are NULL. - #PvResult::Code::NOT_SUPPORTED if the input buffer format is not supported by the filter.

~IPvFilter()

Destructor.

Declaration

protected ~IPvFilter()

GetThreadsPriority(out uint)

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

Declaration

public virtual PvResult GetThreadsPriority(out uint aPriority)

Parameters

Type	Name	Description
uint	aPriority	Output reference to the worker threads priority.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading.

SetThreadsPriority(uint)

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

Declaration

public virtual PvResult SetThreadsPriority(uint aPriority)

Parameters

Type	Name	Description
uint	aPriority	Input reference to the worker threads priority.

Returns

Type	Description
PvResult	Includes: - #PvResult::Code::OK - #PvResult::Code::NOT_SUPPORTED if the filter does not support multi-threading. - #PvResult::Code::INVALID_PARAMETER if aPriority maps to nothing on the target system.

Implements

IDisposable