ob::SequenceIdFilter Class Reference

Create SequenceIdFilter processing block. More...

#include <Filter.hpp>

Inheritance diagram for ob::SequenceIdFilter:

Public Member Functions
	SequenceIdFilter ()
virtual	~SequenceIdFilter () noexcept
void	selectSequenceId (int sequence_id)
	Set the sequenceId filter params.
int	getSelectSequenceId ()
	Get the current sequence id.
OBSequenceIdItem *	getSequenceIdList ()
int	getSequenceIdListSize ()
	Get the sequenceId list size.
Public Member Functions inherited from ob::Filter
	Filter (ob_filter *impl)
virtual	~Filter () noexcept
ob_filter *	getImpl () const
	Get the Impl object of the filter.
virtual const std::string &	getName () const
	Get the type of filter.
virtual void	reset () const
	Reset the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used.
virtual void	enable (bool enable) const
	enable the filter
virtual bool	isEnabled () const
	Return Enable State.
virtual std::shared_ptr< Frame >	process (std::shared_ptr< const Frame > frame) const
	Processes a frame synchronously.
virtual void	pushFrame (std::shared_ptr< Frame > frame) const
	Pushes the pending frame into the cache for asynchronous processing.
virtual void	setCallBack (FilterCallback callback)
	Set the callback function for asynchronous processing.
virtual std::string	getConfigSchema () const
	Get config schema of the filter.
virtual std::vector< OBFilterConfigSchemaItem >	getConfigSchemaVec () const
	Get the Config Schema Vec object.
virtual void	setConfigValue (const std::string &configName, double value) const
	Set the filter config value by name.
virtual double	getConfigValue (const std::string &configName) const
	Get the Config Value object by name.
virtual const char *	type ()
template<typename T >
bool	is ()
	Check if the runtime type of the filter object is compatible with a given type.
template<typename T >
std::shared_ptr< T >	as ()

Additional Inherited Members
Protected Member Functions inherited from ob::Filter
	Filter ()=default
	Default constructor with nullptr impl, used for derived classes only.
virtual void	init (ob_filter *impl)
Protected Attributes inherited from ob::Filter
ob_filter *	impl_ = nullptr
std::string	name_
FilterCallback	callback_
std::vector< OBFilterConfigSchemaItem >	configSchemaVec_

Detailed Description

Create SequenceIdFilter processing block.

Definition at line 475 of file Filter.hpp.

Constructor & Destructor Documentation

SequenceIdFilter()

ob::SequenceIdFilter::SequenceIdFilter ( )

inline

Definition at line 493 of file Filter.hpp.

~SequenceIdFilter()

virtual ob::SequenceIdFilter::~SequenceIdFilter ( )

inlinevirtualnoexcept

Definition at line 501 of file Filter.hpp.

Member Function Documentation

selectSequenceId()

void ob::SequenceIdFilter::selectSequenceId ( int sequence_id )

inline

Set the sequenceId filter params.

Parameters

sequence

id to pass the filter.

Definition at line 513 of file Filter.hpp.

getSelectSequenceId()

int ob::SequenceIdFilter::getSelectSequenceId ( )

inline

Get the current sequence id.

Returns

sequence id to pass the filter.

Definition at line 522 of file Filter.hpp.

getSequenceIdList()

OBSequenceIdItem * ob::SequenceIdFilter::getSequenceIdList ( )

inline

Definition at line 526 of file Filter.hpp.

getSequenceIdListSize()

int ob::SequenceIdFilter::getSequenceIdListSize ( )

inline

Get the sequenceId list size.

Returns

the size of sequenceId list.

Definition at line 535 of file Filter.hpp.

---

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

• C:/Users/hzcyf/Projects/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp