cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Friends | List of all members
svlStreamBranchSource Class Reference

#include <svlStreamBranchSource.h>

Inheritance diagram for svlStreamBranchSource:
svlFilterSourceBase svlFilterBase mtsComponent cmnGenericObject

Public Member Functions

int GetBufferUsage ()
 
double GetBufferUsageRatio ()
 
unsigned int GetDroppedSampleCount ()
 
int BlockInput (bool block)
 
- Public Member Functions inherited from svlFilterSourceBase
 svlFilterSourceBase ()
 
 svlFilterSourceBase (bool autotimestamps)
 
virtual ~svlFilterSourceBase ()
 
virtual void SetTargetFrequency (const double &hertz)
 
virtual double GetTargetFrequency () const
 
virtual void SetLoop (const bool &loop)
 
virtual bool GetLoop () const
 
void Pause ()
 
void Play ()
 
void Play (const int &frames)
 
- Public Member Functions inherited from svlFilterBase
 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
 

Friends

class svlStreamManager
 
class svlFilterOutput
 
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
 
- Protected Member Functions inherited from svlFilterSourceBase
virtual int OnStart (unsigned int procCount)
 
virtual void OnStop ()
 
virtual int Release ()
 
virtual void OnResetTimer ()
 
void ResetTargetTimer ()
 
int RestartTargetTimer ()
 
int StopTargetTimer ()
 
int WaitForTargetTimer ()
 
bool IsTargetTimerRunning ()
 
- Protected Member Functions inherited from svlFilterBase
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)
 
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 inherited from svlFilterBase
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
 

Member Function Documentation

int svlStreamBranchSource::BlockInput ( bool  block)
int svlStreamBranchSource::GetBufferUsage ( )
double svlStreamBranchSource::GetBufferUsageRatio ( )
unsigned int svlStreamBranchSource::GetDroppedSampleCount ( )

Friends And Related Function Documentation

friend class svlFilterOutput
friend
friend class svlStreamManager
friend
friend class svlStreamProc
friend

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