#include <svlFilterBase.h>

Inheritance diagram for svlFilterBase:

Public Member Functions
	svlFilterBase (void)

virtual	~svlFilterBase ()

bool	IsInitialized (void) const

bool	IsRunning (void) const

unsigned int	GetFrameCounter (void) const

svlFilterInput *	GetInput (void) const

svlFilterOutput *	GetOutput (void) const

svlFilterInput *	GetInput (const std::string &inputname) const

svlFilterOutput *	GetOutput (const std::string &outputname) const

void	SetEnable (const bool &enable)

void	GetEnable (bool &enable) const

void	Enable ()

void	Disable ()

bool	IsEnabled () const

bool	IsDisabled () const

Public Member Functions inherited from mtsComponent
	mtsComponent (const std::string &deviceName)

virtual	~mtsComponent ()

const std::string &	GetName (void) const

void	GetName (std::string &placeHolder) const

void	SetName (const std::string &componentName)

virtual void	Configure (const std::string &filename="")

virtual void	Create (void)

bool	CreateAndWait (double timeoutInSeconds)

virtual void	Start (void)

bool	StartAndWait (double timeoutInSeconds)

virtual void	Suspend (void)

virtual void	Kill (void)

bool	KillAndWait (double timeoutInSeconds)

virtual void	Startup (void)

virtual void	Cleanup (void)

mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)

virtual mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)

CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)

virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)

bool	InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const

mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const

size_t	GetNumberOfInterfacesProvided (void) const

size_t	GetNumberOfInterfacesOutput (void) const

bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)

mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)

virtual mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)

CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)

virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)

const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)

mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)

mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const

size_t	GetNumberOfInterfacesRequired (void) const

size_t	GetNumberOfInterfacesInput (void) const

bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)

const mtsManagerComponentServices *	GetManagerComponentServices (void) const

mtsManagerComponentServices *	GetManagerComponentServices (void)

mtsStateTable *	GetStateTable (const std::string &stateTableName)

bool	AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)

void	UseSeparateLogFileDefault (bool forwardToLogger=true)

void	UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)

void	UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)

cmnLogger::StreamBufType *	GetLogMultiplexer (void) const

bool	IsRunning (void) const

bool CISST_DEPRECATED	Running (void) const

bool	IsStarted (void) const

bool	IsTerminated (void) const

bool	IsEndTask (void) const

const mtsComponentState &	GetState (void) const

void	GetState (mtsComponentState &state) const

void	ToStream (std::ostream &outputStream) const

bool	SetReplayMode (void)

bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)

bool	SetReplayTime (const double time)

std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesProvided (void) const

std::vector< std::string >	GetNamesOfInterfacesOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequired (void) const

std::vector< std::string >	GetNamesOfInterfacesInput (void) const

Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)

virtual const cmnClassServicesBase *	Services (void) const =0

bool	ReconstructFrom (const cmnGenericObject &other)

std::string	ToString (void) const

virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const

virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')

virtual void	SerializeRaw (std::ostream &outputStream) const

virtual void	DeSerializeRaw (std::istream &inputStream)

virtual size_t	ScalarNumber (void) const

virtual bool	ScalarNumberIsFixed (void) const

virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)

virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
svlFilterInput *	AddInput (const std::string &inputName, bool trunk=true)

svlFilterOutput *	AddOutput (const std::string &outputName, bool trunk=true)

int	AddInputType (const std::string &inputname, svlStreamType type)

int	SetOutputType (const std::string &outputname, svlStreamType type)

void	SetAutomaticOutputType (bool autotype)

virtual int	OnConnectInput (svlFilterInput &input, svlStreamType type)

virtual int	Initialize (svlSample syncInput, svlSample &syncOutput)=0

virtual int	OnStart (unsigned int procCount)

virtual int	Process (svlProcInfo procInfo, svlSample syncInput, svlSample *&syncOutput)=0

virtual void	OnStop (void)

virtual int	Release (void)

int	IsDataValid (svlStreamType type, svlSample *data)

bool	IsNewSample (svlSample *sample)

Protected Member Functions inherited from mtsComponent
	mtsComponent (void)

	mtsComponent (const mtsComponent &other)

void	Initialize (void)

mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)

mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)

mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)

mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)

mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)

void	KillSeparateLogFile (void)

virtual bool	WaitForState (mtsComponentState desiredState, double timeout)

size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)

size_t	ProcessQueuedCommands (void)

size_t	ProcessQueuedEvents (void)

mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services. More...

bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces. More...

void	InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)

Protected Attributes
unsigned int	FrameCounter

mtsStateTable	StateTable

Protected Attributes inherited from mtsComponent
std::string	Name

mtsComponentState	State

mtsInterfaceProvided *	InterfaceProvidedToManager

bool	UseSeparateLogFileFlag

cmnLogger::StreamBufType *	LoDMultiplexerStreambuf

std::ofstream *	LogFile

StateTableMapType	StateTables

mtsManagerComponentServices *	ManagerComponentServices

mtsFunctionWrite	EventGeneratorChangeState

bool	ReplayMode

InterfacesProvidedMapType	InterfacesProvided

InterfacesOutputMapType	InterfacesOutput

InterfacesRequiredMapType	InterfacesRequired

InterfacesInputMapType	InterfacesInput

Friends
class	svlFilterInput

class	svlFilterOutput

class	svlStreamManager

class	svlStreamProc

Additional Inherited Members
Public Types inherited from mtsComponent
typedef mtsComponent	ThisType

Protected Types inherited from mtsComponent
typedef cmnNamedMap < mtsStateTable >	StateTableMapType

typedef cmnNamedMap < mtsInterfaceProvided >	InterfacesProvidedMapType

typedef cmnNamedMap < mtsInterfaceOutput >	InterfacesOutputMapType

typedef cmnNamedMap < mtsInterfaceRequired >	InterfacesRequiredMapType

typedef cmnNamedMap < mtsInterfaceInput >	InterfacesInputMapType

Constructor & Destructor Documentation

svlFilterBase::svlFilterBase ( void )

virtual svlFilterBase::~svlFilterBase ( )

virtual

Member Function Documentation

svlFilterInput* svlFilterBase::AddInput	(	const std::string &	inputName,
		bool	trunk = `true`
	)

protected

int svlFilterBase::AddInputType	(	const std::string &	inputname,
		svlStreamType	type
	)

protected

svlFilterOutput* svlFilterBase::AddOutput	(	const std::string &	outputName,
		bool	trunk = `true`
	)

protected

void svlFilterBase::Disable ( )

void svlFilterBase::Enable ( )

void svlFilterBase::GetEnable ( bool & enable ) const

unsigned int svlFilterBase::GetFrameCounter ( void ) const

svlFilterInput* svlFilterBase::GetInput ( void ) const

svlFilterInput* svlFilterBase::GetInput ( const std::string & inputname ) const

svlFilterOutput* svlFilterBase::GetOutput ( void ) const

svlFilterOutput* svlFilterBase::GetOutput ( const std::string & outputname ) const

virtual int svlFilterBase::Initialize	(	svlSample *	syncInput,
		svlSample *&	syncOutput
	)

protectedpure virtual

Implemented in svlFilterComputationalStereo, svlFilterImageCenterFinder, svlFilterVideoFileWriter, svlFilterImageTracker, svlFilterImageOverlay, svlFilterImageSampler, svlFilterImageOpenGL, svlFilterImageCameraCalibrationOpenCV, svlFilterImageWindow, svlFilterImageQtWidget, svlFilterFrameTimeSync, svlFilterImageWindowQt, svlFilterImageWindowQtStereo, svlFilterAddLatency, svlFilterImageWindowTargetSelect, svlFilterToolTracker, svlFilterVideoExposureManager, svlFilterImageCropper, svlFilterImageZoom, svlFilterPlaneSegmentation, svlFilterImageFileWriter, svlFilterImageFlipRotate, svlFilterImageExposureCorrection, svlFilterImageRectifier, svlFilterStreamTypeConverter, svlFilterImageBlobDetector, svlFilterSplitter, svlFilterStereoImageOptimizer, svlFilterImageResizer, svlFilterDisparityMapToSurface, svlFilterImageConvolution, svlFilterImageUnsharpMask, svlFilterLightSourceBuddy, svlFilterSampler, svlFilterStereoImageJoiner, svlFilterStereoImageSplitter, svlFilterCapFramerate, svlFilterImageColorSegmentation, svlFilterImageDeinterlacer, svlFilterImageDilation, svlFilterImageErosion, svlFilterImageTranslation, svlFilterImageBorder, svlFilterImageColorConverter, svlFilterImageThresholding, svlFilterImageBlobTracker, svlFilterCUDATest, svlFilterImageChannelSwapper, and svlOSGImage.

int svlFilterBase::IsDataValid	(	svlStreamType	type,
		svlSample *	data
	)

protected

bool svlFilterBase::IsDisabled ( ) const

bool svlFilterBase::IsEnabled ( ) const

bool svlFilterBase::IsInitialized ( void ) const

bool svlFilterBase::IsNewSample ( svlSample * sample )

protected

bool svlFilterBase::IsRunning ( void ) const

virtual int svlFilterBase::OnConnectInput	(	svlFilterInput &	input,
		svlStreamType	type
	)

protectedvirtual

Reimplemented in svlFilterImageTracker, svlFilterImageBlobDetector, svlFilterSplitter, svlFilterStereoImageJoiner, svlFilterStereoImageSplitter, and svlFilterImageColorSegmentation.

virtual int svlFilterBase::OnStart ( unsigned int procCount )

protectedvirtual

Reimplemented in svlFilterVideoFileWriter, svlFilterImageTracker, svlFilterSourceBase, svlFilterSourceVideoFile, svlFilterSourceImageFile, and svlFilterSourceTextFile.

virtual void svlFilterBase::OnStop ( void )

protectedvirtual

Reimplemented in svlFilterImageOverlay, and svlFilterSourceBase.

virtual int svlFilterBase::Process	(	svlProcInfo *	procInfo,
		svlSample *	syncInput,
		svlSample *&	syncOutput
	)

protectedpure virtual

Implemented in svlFilterComputationalStereo, svlFilterVideoFileWriter, svlFilterImageCenterFinder, svlFilterImageTracker, svlFilterImageOverlay, svlFilterImageSampler, svlFilterImageOpenGL, svlFilterImageCameraCalibrationOpenCV, svlFilterImageWindow, svlFilterFrameTimeSync, svlFilterImageQtWidget, svlFilterImageWindowQt, svlFilterImageWindowQtStereo, svlFilterAddLatency, svlFilterImageWindowTargetSelect, svlFilterToolTracker, svlFilterVideoExposureManager, svlFilterImageCropper, svlFilterImageZoom, svlFilterPlaneSegmentation, svlFilterImageFileWriter, svlFilterImageFlipRotate, svlFilterImageExposureCorrection, svlFilterImageRectifier, svlFilterStreamTypeConverter, svlFilterImageBlobDetector, svlFilterSplitter, svlFilterStereoImageOptimizer, svlFilterImageResizer, svlFilterDisparityMapToSurface, svlFilterImageConvolution, svlFilterImageUnsharpMask, svlFilterLightSourceBuddy, svlFilterSampler, svlFilterStereoImageJoiner, svlFilterStereoImageSplitter, svlFilterCapFramerate, svlFilterImageColorSegmentation, svlFilterImageDeinterlacer, svlFilterImageDilation, svlFilterImageErosion, svlFilterImageTranslation, svlFilterImageBorder, svlFilterImageColorConverter, svlFilterImageThresholding, svlFilterImageBlobTracker, svlFilterCUDATest, svlFilterImageChannelSwapper, and svlOSGImage.

virtual int svlFilterBase::Release ( void )

protectedvirtual

Reimplemented in svlFilterSourceVideoCapture, svlFilterComputationalStereo, svlFilterVideoFileWriter, svlFilterImageCenterFinder, svlFilterImageTracker, svlFilterSourceBase, svlFilterImageSampler, svlFilterImageOpenGL, svlFilterSourceVideoFile, svlFilterFrameTimeSync, svlFilterImageWindow, svlFilterImageQtWidget, svlFilterImageWindowQt, svlFilterImageWindowQtStereo, svlFilterAddLatency, svlFilterSourceImageFile, svlFilterToolTracker, svlFilterSource3DSensorFile, svlFilterSourceTextFile, svlFilterImageCropper, svlFilterSourceKinect, svlFilterImageZoom, svlFilterImageFileWriter, svlFilterImageFlipRotate, svlFilterStereoImageOptimizer, svlFilterImageResizer, svlFilterImageUnsharpMask, svlFilterSampler, svlFilterStereoImageJoiner, svlFilterStereoImageSplitter, svlFilterImageDilation, svlFilterImageErosion, svlFilterImageBorder, svlFilterCUDATest, svlFilterImageChannelSwapper, and svlOSGImage.

void svlFilterBase::SetAutomaticOutputType ( bool autotype )

protected

void svlFilterBase::SetEnable ( const bool & enable )

int svlFilterBase::SetOutputType	(	const std::string &	outputname,
		svlStreamType	type
	)

protected

Friends And Related Function Documentation

friend class svlFilterInput

friend

friend class svlFilterOutput

friend

friend class svlStreamManager

friend

friend class svlStreamProc

friend

Member Data Documentation

unsigned int svlFilterBase::FrameCounter

protected

mtsStateTable svlFilterBase::StateTable

protected

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstStereoVision/svlFilterBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation