Spinnaker C++
2.6.0.0
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
TransportLayerStream Class Reference

Part of the QuickSpin API to provide access to camera information without having to first initialize the camera. More...

Public Member Functions

 TransportLayerStream (GenApi::INodeMap *nodeMapTLDevice)
 
 ~TransportLayerStream ()
 

Public Attributes

GenApi::IStringStreamID
 Description: Device unique ID for the data stream, e.g. More...
 
GenApi::IEnumerationT
< StreamTypeEnum > & 
StreamType
 Description: Stream type of the device. More...
 
GenApi::IEnumerationT
< StreamModeEnum > & 
StreamMode
 Description: Stream mode of the device. More...
 
GenApi::IIntegerStreamBufferCountManual
 Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode. More...
 
GenApi::IIntegerStreamBufferCountResult
 Description: Displays the number of buffers to be used on this stream upon acquisition start. More...
 
GenApi::IIntegerStreamBufferCountMax
 Description: Controls the maximum number of buffers that should be used on this stream. More...
 
GenApi::IEnumerationT
< StreamBufferCountModeEnum > & 
StreamBufferCountMode
 Description: Controls access to setting the number of buffers used for the stream. More...
 
GenApi::IEnumerationT
< StreamBufferHandlingModeEnum > & 
StreamBufferHandlingMode
 Description: Available buffer handling modes of this data stream: Visibility: Beginner. More...
 
GenApi::IIntegerStreamAnnounceBufferMinimum
 Description: Minimal number of buffers to announce to enable selected buffer handling mode. More...
 
GenApi::IIntegerStreamAnnouncedBufferCount
 Description: Number of announced (known) buffers on this stream. More...
 
GenApi::IIntegerStreamStartedFrameCount
 Description: Number of frames started in the acquisition engine. More...
 
GenApi::IIntegerStreamDeliveredFrameCount
 Description: Number of delivered frames since last acquisition start. More...
 
GenApi::IIntegerStreamReceivedFrameCount
 Description: Number of successful GVSP data blocks received. More...
 
GenApi::IIntegerStreamIncompleteFrameCount
 Description: Displays number of images with missing packet. More...
 
GenApi::IIntegerStreamLostFrameCount
 Description: Number of lost frames due to queue underrun. More...
 
GenApi::IIntegerStreamDroppedFrameCount
 Description: Number of dropped frames due to queue overrun. More...
 
GenApi::IIntegerStreamInputBufferCount
 Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled. More...
 
GenApi::IIntegerStreamOutputBufferCount
 Description: Number of buffers in the output buffer queue. More...
 
GenApi::IBooleanStreamIsGrabbing
 Description: Flag indicating whether the acquisition engine is started or not. More...
 
GenApi::IIntegerStreamChunkCountMaximum
 Description: Maximum number of chunks to be expected in a buffer. More...
 
GenApi::IIntegerStreamBufferAlignment
 Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer. More...
 
GenApi::IBooleanStreamCRCCheckEnable
 Description: Enables or disables CRC checks on received images. More...
 
GenApi::IIntegerStreamReceivedPacketCount
 Description: Displays number of packets received on this stream. More...
 
GenApi::IIntegerStreamMissedPacketCount
 Description: Displays number of packets missed by this stream. More...
 
GenApi::IBooleanStreamPacketResendEnable
 Description: Enables or disables the packet resend mechanism. More...
 
GenApi::IIntegerStreamPacketResendTimeout
 Description: Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver. More...
 
GenApi::IIntegerStreamPacketResendMaxRequests
 Description: Maximum number of resend requests per image. More...
 
GenApi::IIntegerStreamPacketResendRequestCount
 Description: Displays number of packet resend requests transmitted to the camera. More...
 
GenApi::IIntegerStreamPacketResendRequestSuccessCount
 Description: Displays number of packet resend requests successfully transmitted to the camera. More...
 
GenApi::IIntegerStreamPacketResendRequestedPacketCount
 Description: Displays number of packets requested to be retransmitted on this stream. More...
 
GenApi::IIntegerStreamPacketResendReceivedPacketCount
 Description: Displays number of retransmitted packets received on this stream. More...
 
GenApi::IBooleanGevPacketResendMode
 Description: DEPRECATED; Replaced by StreamPacketResendEnable. More...
 
GenApi::IIntegerGevMaximumNumberResendRequests
 Description: DEPRECATED; Replaced by StreamPacketResendMaxRequests. More...
 
GenApi::IIntegerGevPacketResendTimeout
 Description: DEPRECATED; Replaced by StreamPacketResendTimeout. More...
 
GenApi::IIntegerGevTotalPacketCount
 Description: DEPRECATED; Replaced by StreamReceivedPacketCount. More...
 
GenApi::IIntegerGevFailedPacketCount
 Description: DEPRECATED; Replaced by StreamMissedPacketCount. More...
 
GenApi::IIntegerGevResendPacketCount
 Description: DEPRECATED; Replaced by StreamPacketResendReceivedPacketCount. More...
 
GenApi::IIntegerStreamFailedBufferCount
 Description: DEPRECATED; Replaced by StreamIncompleteFrameCount. More...
 
GenApi::IIntegerGevResendRequestCount
 Description: DEPRECATED; Replaced by StreamPacketResendRequestedPacketCount. More...
 
GenApi::IIntegerStreamBlockTransferSize
 Description: Controls the image breakup size that should be used on this stream. More...
 

Protected Member Functions

 TransportLayerStream ()
 

Friends

class CameraBase
 
class ICameraBase
 
class CameraInternal
 

Detailed Description

Part of the QuickSpin API to provide access to camera information without having to first initialize the camera.

Examples:
GigEVisionPerformance.cpp.

Constructor & Destructor Documentation

TransportLayerStream ( GenApi::INodeMap nodeMapTLDevice)
TransportLayerStream ( )
protected

Friends And Related Function Documentation

friend class CameraBase
friend
friend class CameraInternal
friend
friend class ICameraBase
friend

Member Data Documentation

GenApi::IInteger& GevFailedPacketCount

Description: DEPRECATED; Replaced by StreamMissedPacketCount.

Displays number of packets missed by this stream. Successful resent packets are not counted as a missed packet. Visibility: Invisible

GenApi::IInteger& GevMaximumNumberResendRequests

Description: DEPRECATED; Replaced by StreamPacketResendMaxRequests.

Maximum number of resend requests per image. Each resend request consists of a span of consecutive packet IDs. Visibility: Invisible

GenApi::IBoolean& GevPacketResendMode

Description: DEPRECATED; Replaced by StreamPacketResendEnable.

Enables or disables the packet resend mechanism. Visibility: Invisible

GenApi::IInteger& GevPacketResendTimeout

Description: DEPRECATED; Replaced by StreamPacketResendTimeout.

Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver. Visibility: Invisible

GenApi::IInteger& GevResendPacketCount

Description: DEPRECATED; Replaced by StreamPacketResendReceivedPacketCount.

Displays number of packets received after retransmit request on this stream. Visibility: Invisible

GenApi::IInteger& GevResendRequestCount

Description: DEPRECATED; Replaced by StreamPacketResendRequestedPacketCount.

Displays number of packets requested to be retransmitted on this stream. Visibility: Invisible

GenApi::IInteger& GevTotalPacketCount

Description: DEPRECATED; Replaced by StreamReceivedPacketCount.

Displays number of packets received on this stream. Visibility: Invisible

GenApi::IInteger& StreamAnnounceBufferMinimum

Description: Minimal number of buffers to announce to enable selected buffer handling mode.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamAnnouncedBufferCount

Description: Number of announced (known) buffers on this stream.

This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamBlockTransferSize

Description: Controls the image breakup size that should be used on this stream.

Visibility: Expert

GenApi::IInteger& StreamBufferAlignment

Description: Alignment size in bytes of the buffer passed to DSAnnounceBuffer.

Visibility: Expert

GenApi::IInteger& StreamBufferCountManual

Description: Controls the number of buffers to be used on this stream upon acquisition start when in manual mode.

Visibility: Expert

GenApi::IInteger& StreamBufferCountMax

Description: Controls the maximum number of buffers that should be used on this stream.

This value is calculated based on the available system memory. Visibility: Expert

Description: Controls access to setting the number of buffers used for the stream.

Visibility: Expert

GenApi::IInteger& StreamBufferCountResult

Description: Displays the number of buffers to be used on this stream upon acquisition start.

Recalculated on acquisition start if in auto mode. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.

Description: Available buffer handling modes of this data stream: Visibility: Beginner.

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamChunkCountMaximum

Description: Maximum number of chunks to be expected in a buffer.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IBoolean& StreamCRCCheckEnable

Description: Enables or disables CRC checks on received images.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamDeliveredFrameCount

Description: Number of delivered frames since last acquisition start.

It is not reset until the stream is closed. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamDroppedFrameCount

Description: Number of dropped frames due to queue overrun.

This number is initialized with zero at the time the stream is opened and incremented every time old data is dropped from the output list for new data. It is not reset until the stream is closed. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamFailedBufferCount

Description: DEPRECATED; Replaced by StreamIncompleteFrameCount.

Displays number of images with missing packet. Visibility: Invisible

GenApi::IString& StreamID

Description: Device unique ID for the data stream, e.g.

a GUID. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamIncompleteFrameCount

Description: Displays number of images with missing packet.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamInputBufferCount

Description: Number of buffers in the input buffer pool plus the buffers(s) currently being filled.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IBoolean& StreamIsGrabbing

Description: Flag indicating whether the acquisition engine is started or not.

Visibility: Expert

GenApi::IInteger& StreamLostFrameCount

Description: Number of lost frames due to queue underrun.

This number is initialized with zero at the time the stream is opened and incremented every time the data could not be acquired because there was no buffer in the input buffer pool. It is not reset until the stream is closed. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamMissedPacketCount

Description: Displays number of packets missed by this stream.

Successful resent packets are not counted as a missed packet. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.

Description: Stream mode of the device.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamOutputBufferCount

Description: Number of buffers in the output buffer queue.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IBoolean& StreamPacketResendEnable

Description: Enables or disables the packet resend mechanism.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendMaxRequests

Description: Maximum number of resend requests per image.

Each resend request consists of a span of consecutive packet IDs. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendReceivedPacketCount

Description: Displays number of retransmitted packets received on this stream.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendRequestCount

Description: Displays number of packet resend requests transmitted to the camera.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendRequestedPacketCount

Description: Displays number of packets requested to be retransmitted on this stream.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendRequestSuccessCount

Description: Displays number of packet resend requests successfully transmitted to the camera.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamPacketResendTimeout

Description: Time in milliseconds to wait after the image trailer is received and before the image is completed by the driver.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamReceivedFrameCount

Description: Number of successful GVSP data blocks received.

Only valid while stream is active. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamReceivedPacketCount

Description: Displays number of packets received on this stream.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.
GenApi::IInteger& StreamStartedFrameCount

Description: Number of frames started in the acquisition engine.

This number is incremented every time in case of a new buffer is started and then to be filled (data written to) regardless even if the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at at the time of the stream is opened. It is not reset until the stream is closed. Visibility: Expert

Examples:
GigEVisionPerformance.cpp.

Description: Stream type of the device.

Visibility: Expert

Examples:
GigEVisionPerformance.cpp.

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference