Class Spinnaker::IDataStream

ClassList > Spinnaker > IDataStream

• #include <IStream.h>

Public Functions

Type	Name
virtual void	AnnounceGenTLOwnedImage (size_t size) = 0
virtual void	AnnounceUserOwnedImage (size_t size, void * pData) = 0
virtual void	AttachBuffer (uint8_t * pBuffer, GenApi::SingleChunkData_t * ChunkData, int64_t NumChunks) = 0
virtual void	AttachBuffer (uint8_t * pBuffer, int64_t BufferLength) = 0
virtual void	FlushQueueAllDiscard () = 0
virtual GenTL::GC_ERROR	GetBufferChunkData (GenTL::BUFFER_HANDLE hBuffer, GenTL::SINGLE_CHUNK_DATA * pChunkData, size_t * piNumChunks) = 0
virtual bool	GetBufferInfoBool8Type (GenTL::BUFFER_HANDLE hBuffer, GenTL::BUFFER_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 GenApi::INodeMap *	GetDeviceNodeMap () const = 0
virtual ImagePtr	GetNextImage (uint64_t grabTimeout) = 0
virtual ImagePtr	GetNextImageInternal (void ** ppPrivate, uint64_t grabTimeout) = 0
virtual ImageList	GetNextImageList (uint64_t grabTimeout) = 0
virtual ImageList	GetNextImageListInternal (void ** ppPrivate, uint64_t grabTimeout) = 0
virtual GenApi::INodeMap &	GetNodeMap () const = 0
virtual unsigned int	GetNumImagesInUse () const = 0
virtual Port &	GetPort () const = 0
virtual std::string	GetSerialNumber () const = 0
virtual std::string	GetStreamID () const = 0
virtual uint64_t	GetStreamIndex () const = 0
virtual bool	GetStreamInfoBool8Type (GenTL::STREAM_INFO_CMD iInfoCmd) = 0
virtual size_t	GetStreamInfoSizeType (GenTL::STREAM_INFO_CMD iInfoCmd) = 0
virtual StreamTypeEnum	GetStreamType () const = 0
virtual bool	IsAutoPollingEventHandlerRegistered () = 0
virtual bool	IsCRCCheckEnabled () const = 0
virtual bool	IsEventHandlerRegistered (IImageEventHandler & imageEventHandler) = 0
virtual bool	IsEventHandlerRegistered (IImageListEventHandler & imageEventHandler) = 0
virtual bool	IsImageBufferInUse (const BUFFER_HANDLE bufferHandle) = 0
virtual bool	IsStreaming () = 0
virtual void	KillBufferEvent () = 0
virtual void	RegisterImageEventHandler (IImageEventHandler & imageEventHandler, EventPollingOptions pollingOption) = 0
virtual void	RegisterImageListEventHandler (IImageListEventHandler & imageListEventHandler) = 0
virtual void	RegisterLoggingEventHandler (ILoggingEventHandler & loggingEventHandler) = 0
virtual void	ReleaseImageBuffer (const BUFFER_HANDLE bufferHandle) = 0
virtual void	ResetStreamHandle (std::shared_ptr< Spinnaker::IGenTLDevice > pDevice) = 0
virtual void	RevokeImages () = 0
virtual void	SetChunkAdapter (std::shared_ptr< GenApi::CChunkAdapter > chunkAdapter, SpinGenApiChunkAdapterType chunkAdapterType, GenApi::INodeMap & nodemap) = 0
virtual void	SetExpectedImagePayloadType (Spinnaker::ImagePayloadType expectedPayloadType) = 0
virtual void	StartStream (const unsigned int stream_index=0) = 0
virtual void	StopStream () = 0
virtual const TransportLayerStream &	TransportLayerStreamInfo () const = 0
virtual void	UnregisterAllLoggingEventHandlers () = 0
virtual void	UnregisterImageEventHandler (IImageEventHandler & imageEventHandler) = 0
virtual void	UnregisterImageListEventHandler (IImageListEventHandler & imageEventHandler) = 0
virtual void	UnregisterLoggingEventHandler (ILoggingEventHandler & loggingEventHandler) = 0
virtual void	WaitOnImageEvent (uint64_t timeout) = 0
virtual	~IDataStream ()

Protected Functions

Type	Name
	IDataStream ()

Public Functions Documentation

function AnnounceGenTLOwnedImage

virtual void Spinnaker::IDataStream::AnnounceGenTLOwnedImage (
    size_t size
) = 0

---

function AnnounceUserOwnedImage

virtual void Spinnaker::IDataStream::AnnounceUserOwnedImage (
    size_t size,
    void * pData
) = 0

---

function AttachBuffer [1/2]

virtual void Spinnaker::IDataStream::AttachBuffer (
    uint8_t * pBuffer,
    GenApi::SingleChunkData_t * ChunkData,
    int64_t NumChunks
) = 0

---

function AttachBuffer [2/2]

virtual void Spinnaker::IDataStream::AttachBuffer (
    uint8_t * pBuffer,
    int64_t BufferLength
) = 0

---

function FlushQueueAllDiscard

virtual void Spinnaker::IDataStream::FlushQueueAllDiscard () = 0

---

function GetBufferChunkData

virtual GenTL::GC_ERROR Spinnaker::IDataStream::GetBufferChunkData (
    GenTL::BUFFER_HANDLE hBuffer,
    GenTL::SINGLE_CHUNK_DATA * pChunkData,
    size_t * piNumChunks
) = 0

---

function GetBufferInfoBool8Type

virtual bool Spinnaker::IDataStream::GetBufferInfoBool8Type (
    GenTL::BUFFER_HANDLE hBuffer,
    GenTL::BUFFER_INFO_CMD iInfoCmd
) = 0

---

function GetBufferInfoPtrType

virtual void * Spinnaker::IDataStream::GetBufferInfoPtrType (
    GenTL::BUFFER_HANDLE hBuffer,
    GenTL::BUFFER_INFO_CMD iInfoCmd
) = 0

---

function GetBufferInfoSizeType

virtual size_t Spinnaker::IDataStream::GetBufferInfoSizeType (
    GenTL::BUFFER_HANDLE hBuffer,
    GenTL::BUFFER_INFO_CMD iInfoCmd
) = 0

---

function GetBufferInfoUInt64Type

virtual uint64_t Spinnaker::IDataStream::GetBufferInfoUInt64Type (
    GenTL::BUFFER_HANDLE hBuffer,
    GenTL::BUFFER_INFO_CMD iInfoCmd
) = 0

---

function GetDeviceNodeMap

virtual GenApi::INodeMap * Spinnaker::IDataStream::GetDeviceNodeMap () const = 0

---

function GetNextImage

virtual ImagePtr Spinnaker::IDataStream::GetNextImage (
    uint64_t grabTimeout
) = 0

---

function GetNextImageInternal

virtual ImagePtr Spinnaker::IDataStream::GetNextImageInternal (
    void ** ppPrivate,
    uint64_t grabTimeout
) = 0

---

function GetNextImageList

virtual ImageList Spinnaker::IDataStream::GetNextImageList (
    uint64_t grabTimeout
) = 0

---

function GetNextImageListInternal

virtual ImageList Spinnaker::IDataStream::GetNextImageListInternal (
    void ** ppPrivate,
    uint64_t grabTimeout
) = 0

---

function GetNodeMap

virtual GenApi::INodeMap & Spinnaker::IDataStream::GetNodeMap () const = 0

---

function GetNumImagesInUse

virtual unsigned int Spinnaker::IDataStream::GetNumImagesInUse () const = 0

---

function GetPort

virtual Port & Spinnaker::IDataStream::GetPort () const = 0

---

function GetSerialNumber

virtual std::string Spinnaker::IDataStream::GetSerialNumber () const = 0

---

function GetStreamID

virtual std::string Spinnaker::IDataStream::GetStreamID () const = 0

---

function GetStreamIndex

virtual uint64_t Spinnaker::IDataStream::GetStreamIndex () const = 0

---

function GetStreamInfoBool8Type

virtual bool Spinnaker::IDataStream::GetStreamInfoBool8Type (
    GenTL::STREAM_INFO_CMD iInfoCmd
) = 0

---

function GetStreamInfoSizeType

virtual size_t Spinnaker::IDataStream::GetStreamInfoSizeType (
    GenTL::STREAM_INFO_CMD iInfoCmd
) = 0

---

function GetStreamType

virtual StreamTypeEnum Spinnaker::IDataStream::GetStreamType () const = 0

---

function IsAutoPollingEventHandlerRegistered

virtual bool Spinnaker::IDataStream::IsAutoPollingEventHandlerRegistered () = 0

---

function IsCRCCheckEnabled

virtual bool Spinnaker::IDataStream::IsCRCCheckEnabled () const = 0

---

function IsEventHandlerRegistered [1/2]

virtual bool Spinnaker::IDataStream::IsEventHandlerRegistered (
    IImageEventHandler & imageEventHandler
) = 0

---

function IsEventHandlerRegistered [2/2]

virtual bool Spinnaker::IDataStream::IsEventHandlerRegistered (
    IImageListEventHandler & imageEventHandler
) = 0

---

function IsImageBufferInUse

virtual bool Spinnaker::IDataStream::IsImageBufferInUse (
    const BUFFER_HANDLE bufferHandle
) = 0

---

function IsStreaming

virtual bool Spinnaker::IDataStream::IsStreaming () = 0

---

function KillBufferEvent

virtual void Spinnaker::IDataStream::KillBufferEvent () = 0

---

function RegisterImageEventHandler

virtual void Spinnaker::IDataStream::RegisterImageEventHandler (
    IImageEventHandler & imageEventHandler,
    EventPollingOptions pollingOption
) = 0

---

function RegisterImageListEventHandler

virtual void Spinnaker::IDataStream::RegisterImageListEventHandler (
    IImageListEventHandler & imageListEventHandler
) = 0

---

function RegisterLoggingEventHandler

virtual void Spinnaker::IDataStream::RegisterLoggingEventHandler (
    ILoggingEventHandler & loggingEventHandler
) = 0

---

function ReleaseImageBuffer

virtual void Spinnaker::IDataStream::ReleaseImageBuffer (
    const BUFFER_HANDLE bufferHandle
) = 0

---

function ResetStreamHandle

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

---

function RevokeImages

virtual void Spinnaker::IDataStream::RevokeImages () = 0

---

function SetChunkAdapter

virtual void Spinnaker::IDataStream::SetChunkAdapter (
    std::shared_ptr< GenApi::CChunkAdapter > chunkAdapter,
    SpinGenApiChunkAdapterType chunkAdapterType,
    GenApi::INodeMap & nodemap
) = 0

---

function SetExpectedImagePayloadType

virtual void Spinnaker::IDataStream::SetExpectedImagePayloadType (
    Spinnaker::ImagePayloadType expectedPayloadType
) = 0

---

function StartStream

virtual void Spinnaker::IDataStream::StartStream (
    const unsigned int stream_index=0
) = 0

---

function StopStream

virtual void Spinnaker::IDataStream::StopStream () = 0

---

function TransportLayerStreamInfo

virtual const TransportLayerStream & Spinnaker::IDataStream::TransportLayerStreamInfo () const = 0

---

function UnregisterAllLoggingEventHandlers

virtual void Spinnaker::IDataStream::UnregisterAllLoggingEventHandlers () = 0

---

function UnregisterImageEventHandler

virtual void Spinnaker::IDataStream::UnregisterImageEventHandler (
    IImageEventHandler & imageEventHandler
) = 0

---

function UnregisterImageListEventHandler

virtual void Spinnaker::IDataStream::UnregisterImageListEventHandler (
    IImageListEventHandler & imageEventHandler
) = 0

---

function UnregisterLoggingEventHandler

virtual void Spinnaker::IDataStream::UnregisterLoggingEventHandler (
    ILoggingEventHandler & loggingEventHandler
) = 0

---

function WaitOnImageEvent

virtual void Spinnaker::IDataStream::WaitOnImageEvent (
    uint64_t timeout
) = 0

---

function ~IDataStream

inline virtual Spinnaker::IDataStream::~IDataStream () 

---

Protected Functions Documentation

function IDataStream

inline Spinnaker::IDataStream::IDataStream () 

---

---

The documentation for this class was generated from the following file C:/workspace/include/Interface/IStream.h