Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties

DownsampleFilter Class Reference

Downsample filter. More...

#include <downsamplefilter.h>

List of all members.

Public Member Functions

unsigned int bufferSize () const
 Buffer size for downsampling.
void setBufferSize (unsigned int size)
 Set buffer size for downsampling.
int timeout () const
 Timeout in milliseconds for discarding too old samples from buffer.
void setTimeout (int ms)
 Set timeout in milliseconds for discarding too old samples from buffer.

Static Public Member Functions

static FilterBase * factoryMethod ()
 Factory method.

Protected Member Functions

 DownsampleFilter ()
 Constructor.

Properties

unsigned int
int timeout

Detailed Description

Downsample filter.

Downsamples incoming XYZ data by having defined buffer sizes from where average will be calculated when the buffer is full. Timeout can be used to control how old samples get discarded.

Definition at line 41 of file downsamplefilter.h.


Constructor & Destructor Documentation

DownsampleFilter::DownsampleFilter (  )  [protected]

Constructor.


Member Function Documentation

unsigned int DownsampleFilter::bufferSize (  )  const

Buffer size for downsampling.

Returns:
buffer size.
static FilterBase* DownsampleFilter::factoryMethod (  )  [inline, static]

Factory method.

Returns:
New DownsampleFilter instance.

Definition at line 55 of file downsamplefilter.h.

void DownsampleFilter::setBufferSize ( unsigned int  size  ) 

Set buffer size for downsampling.

Parameters:
size buffer size.
void DownsampleFilter::setTimeout ( int  ms  ) 

Set timeout in milliseconds for discarding too old samples from buffer.

Parameters:
ms timeout in milliseconds.
int DownsampleFilter::timeout (  )  const

Timeout in milliseconds for discarding too old samples from buffer.

Returns:
timeout in milliseconds.

Property Documentation

unsigned DownsampleFilter::int [read, write]

Definition at line 45 of file downsamplefilter.h.

int DownsampleFilter::timeout [read, write]

Definition at line 46 of file downsamplefilter.h.


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