IDataStream Class Reference

#include <IStream.h>

Public Member Functions
virtual	~IDataStream ()
virtual std::string	GetStreamID () const =0
virtual uint64_t	GetStreamIndex () const =0
virtual void	ResetStreamHandle (std::shared_ptr< Spinnaker::IGenTLDevice > pDevice)=0
virtual StreamTypeEnum	GetStreamType () const =0
virtual void	SetExpectedImagePayloadType (Spinnaker::ImagePayloadType expectedPayloadType)=0
virtual void	AnnounceGenTLOwnedImage (size_t size)=0
virtual void	AnnounceUserOwnedImage (size_t size, void *pData)=0
virtual void	RevokeImages ()=0
virtual void	StartStream (const unsigned int stream_index=0)=0
virtual void	StopStream ()=0
virtual ImagePtr	GetNextImage (uint64_t grabTimeout)=0
virtual ImagePtr	GetNextImageInternal (void **ppPrivate, uint64_t grabTimeout)=0
virtual void	ReleaseImageBuffer (const BUFFER_HANDLE bufferHandle)=0
virtual void	FlushQueueAllDiscard ()=0
virtual bool	IsStreaming ()=0
virtual void	KillBufferEvent ()=0
virtual bool	IsImageBufferInUse (const BUFFER_HANDLE bufferHandle)=0
virtual unsigned int	GetNumImagesInUse () const =0
virtual size_t	GetStreamInfoSizeType (GenTL::STREAM_INFO_CMD iInfoCmd)=0
virtual bool	GetStreamInfoBool8Type (GenTL::STREAM_INFO_CMD iInfoCmd)=0
virtual void *	GetBufferInfoPtrType (GenTL::BUFFER_HANDLE hBuffer, GenTL::BUFFER_INFO_CMD iInfoCmd)=0
virtual size_t	GetBufferInfoSizeType (GenTL::BUFFER_HANDLE hBuffer, GenTL::BUFFER_INFO_CMD iInfoCmd)=0
virtual uint64_t	GetBufferInfoUInt64Type (GenTL::BUFFER_HANDLE hBuffer, GenTL::BUFFER_INFO_CMD iInfoCmd)=0
virtual bool	GetBufferInfoBool8Type (GenTL::BUFFER_HANDLE hBuffer, GenTL::BUFFER_INFO_CMD iInfoCmd)=0
virtual void	RegisterImageEventHandler (IImageEventHandler &imageEventHandler, EventPollingOptions pollingOption)=0
virtual void	UnregisterImageEventHandler (IImageEventHandler &imageEventHandler)=0
virtual bool	IsEventHandlerRegistered (IImageEventHandler &imageEventHandler)=0
virtual bool	IsAutoPollingEventHandlerRegistered ()=0
virtual void	WaitOnImageEvent (uint64_t timeout)=0
virtual void	RegisterImageListEventHandler (IImageListEventHandler &imageListEventHandler)=0
virtual void	UnregisterImageListEventHandler (IImageListEventHandler &imageEventHandler)=0
virtual bool	IsEventHandlerRegistered (IImageListEventHandler &imageEventHandler)=0
virtual void	InitChunkAdapter (GenApi::INodeMap &nodemap)=0
virtual void	CleanupChunkAdapter ()=0
virtual GenTL::GC_ERROR	GetBufferChunkData (GenTL::BUFFER_HANDLE hBuffer, GenTL::SINGLE_CHUNK_DATA *pChunkData, size_t *piNumChunks)=0
virtual void	AttachBuffer (uint8_t *pBuffer, GenApi::SingleChunkData_t *ChunkData, int64_t NumChunks)=0
virtual bool	IsCRCCheckEnabled () const =0
virtual GenApi::INodeMap &	GetNodeMap () const =0
virtual GenApi::INodeMap *	GetDeviceNodeMap () const =0
virtual Port &	GetPort () const =0
virtual const TransportLayerStream &	TransportLayerStreamInfo () const =0

Protected Member Functions
	IDataStream ()

Constructor & Destructor Documentation

~IDataStream()

virtual ~IDataStream ( )

inlinevirtual

IDataStream()

IDataStream ( )

inlineprotected

Member Function Documentation

AnnounceGenTLOwnedImage()

virtual void AnnounceGenTLOwnedImage ( size_t  size )

pure virtual

AnnounceUserOwnedImage()

virtual void AnnounceUserOwnedImage ( size_t  size, void *  pData  )

pure virtual

AttachBuffer()

virtual void AttachBuffer ( uint8_t *  pBuffer, GenApi::SingleChunkData_t *  ChunkData, int64_t  NumChunks  )

pure virtual

CleanupChunkAdapter()

virtual void CleanupChunkAdapter ( )

pure virtual

FlushQueueAllDiscard()

virtual void FlushQueueAllDiscard ( )

pure virtual

GetBufferChunkData()

virtual GenTL::GC_ERROR GetBufferChunkData ( GenTL::BUFFER_HANDLE  hBuffer, GenTL::SINGLE_CHUNK_DATA *  pChunkData, size_t *  piNumChunks  )

pure virtual

GetBufferInfoBool8Type()

virtual bool GetBufferInfoBool8Type ( GenTL::BUFFER_HANDLE  hBuffer, GenTL::BUFFER_INFO_CMD  iInfoCmd  )

pure virtual

GetBufferInfoPtrType()

virtual void * GetBufferInfoPtrType ( GenTL::BUFFER_HANDLE  hBuffer, GenTL::BUFFER_INFO_CMD  iInfoCmd  )

pure virtual

GetBufferInfoSizeType()

virtual size_t GetBufferInfoSizeType ( GenTL::BUFFER_HANDLE  hBuffer, GenTL::BUFFER_INFO_CMD  iInfoCmd  )

pure virtual

GetBufferInfoUInt64Type()

virtual uint64_t GetBufferInfoUInt64Type ( GenTL::BUFFER_HANDLE  hBuffer, GenTL::BUFFER_INFO_CMD  iInfoCmd  )

pure virtual

GetDeviceNodeMap()

virtual GenApi::INodeMap * GetDeviceNodeMap ( ) const

pure virtual

GetNextImage()

virtual ImagePtr GetNextImage ( uint64_t  grabTimeout )

pure virtual

GetNextImageInternal()

virtual ImagePtr GetNextImageInternal ( void **  ppPrivate, uint64_t  grabTimeout  )

pure virtual

GetNodeMap()

virtual GenApi::INodeMap & GetNodeMap ( ) const

pure virtual

GetNumImagesInUse()

virtual unsigned int GetNumImagesInUse ( ) const

pure virtual

GetPort()

virtual Port & GetPort ( ) const

pure virtual

GetStreamID()

virtual std::string GetStreamID ( ) const

pure virtual

GetStreamIndex()

virtual uint64_t GetStreamIndex ( ) const

pure virtual

GetStreamInfoBool8Type()

virtual bool GetStreamInfoBool8Type ( GenTL::STREAM_INFO_CMD  iInfoCmd )

pure virtual

GetStreamInfoSizeType()

virtual size_t GetStreamInfoSizeType ( GenTL::STREAM_INFO_CMD  iInfoCmd )

pure virtual

GetStreamType()

virtual StreamTypeEnum GetStreamType ( ) const

pure virtual

InitChunkAdapter()

virtual void InitChunkAdapter ( GenApi::INodeMap &  nodemap )

pure virtual

IsAutoPollingEventHandlerRegistered()

virtual bool IsAutoPollingEventHandlerRegistered ( )

pure virtual

IsCRCCheckEnabled()

virtual bool IsCRCCheckEnabled ( ) const

pure virtual

IsEventHandlerRegistered() [1/2]

virtual bool IsEventHandlerRegistered ( IImageEventHandler &  imageEventHandler )

pure virtual

IsEventHandlerRegistered() [2/2]

virtual bool IsEventHandlerRegistered ( IImageListEventHandler &  imageEventHandler )

pure virtual

IsImageBufferInUse()

virtual bool IsImageBufferInUse ( const BUFFER_HANDLE  bufferHandle )

pure virtual

IsStreaming()

virtual bool IsStreaming ( )

pure virtual

KillBufferEvent()

virtual void KillBufferEvent ( )

pure virtual

RegisterImageEventHandler()

virtual void RegisterImageEventHandler ( IImageEventHandler &  imageEventHandler, EventPollingOptions  pollingOption  )

pure virtual

RegisterImageListEventHandler()

virtual void RegisterImageListEventHandler ( IImageListEventHandler &  imageListEventHandler )

pure virtual

ReleaseImageBuffer()

virtual void ReleaseImageBuffer ( const BUFFER_HANDLE  bufferHandle )

pure virtual

ResetStreamHandle()

virtual void ResetStreamHandle ( std::shared_ptr< Spinnaker::IGenTLDevice >  pDevice )

pure virtual

RevokeImages()

virtual void RevokeImages ( )

pure virtual

SetExpectedImagePayloadType()

virtual void SetExpectedImagePayloadType ( Spinnaker::ImagePayloadType  expectedPayloadType )

pure virtual

StartStream()

virtual void StartStream ( const unsigned int  stream_index = 0 )

pure virtual

StopStream()

virtual void StopStream ( )

pure virtual

TransportLayerStreamInfo()

virtual const TransportLayerStream & TransportLayerStreamInfo ( ) const

pure virtual

UnregisterImageEventHandler()

virtual void UnregisterImageEventHandler ( IImageEventHandler &  imageEventHandler )

pure virtual

UnregisterImageListEventHandler()

virtual void UnregisterImageListEventHandler ( IImageListEventHandler &  imageEventHandler )

pure virtual

WaitOnImageEvent()

virtual void WaitOnImageEvent ( uint64_t  timeout )

pure virtual

---

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

• include/Interface/IStream.h