Low Level API: Class for pylon GigE Vision cameras providing access to stream grabber related methods and parameters. More...
#include <pylon/gige/PylonGigECamera.h>
Public Member Functions | |
Construction | |
CPylonGigEStreamGrabber () | |
Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber. More... | |
CPylonGigEStreamGrabber (IStreamGrabber *pStreamGrabber) | |
Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber. More... | |
Some smart pointer functionality | |
virtual void | Attach (IStreamGrabber *) |
Attach a pylon stream grabber. | |
virtual bool | IsAttached () const |
Checks if a pylon stream grabber is attached. | |
virtual IStreamGrabber * | GetStreamGrabber () const |
Returns the pylon stream grabber interface pointer. | |
Some smart pointer functionality | |
virtual void | Attach (GenApi::INodeMap *, bool replace=false) |
Attach a pylon node map. | |
virtual GenApi::INodeMap * | GetNodeMap () const |
Returns the pylon node map interface pointer. | |
Implementation of the IStreamGrabber interface | |
See Pylon::IStreamGrabber for more details. | |
void | Open () |
Opens the stream grabber. More... | |
void | Close () |
Closes the stream grabber. More... | |
bool | IsOpen () const |
Retrieve whether the stream grabber is open. More... | |
StreamBufferHandle | RegisterBuffer (void *Buffer, size_t BufferSize) |
Registers a buffer for subsequent use. More... | |
const void * | DeregisterBuffer (StreamBufferHandle handle) |
Deregisters the buffer. More... | |
void | PrepareGrab () |
Prepares grabbing. More... | |
void | FinishGrab () |
Stops grabbing. More... | |
void | QueueBuffer (StreamBufferHandle Handle, const void *Context=NULL) |
Enqueues a buffer in the input queue. More... | |
void | CancelGrab () |
Cancels pending requests. More... | |
bool | RetrieveResult (GrabResult &Result) |
Retrieves a grab result from the output queue. More... | |
WaitObject & | GetWaitObject () const |
Returns the result event object. More... | |
GenApi::INodeMap * | GetNodeMap () |
Returns the associated stream grabber parameters. More... | |
Partial implementation of the INodeMap interface | |
See GENAPI_NAMESPACE::INodeMap for more details | |
void | GetNodes (GenApi::NodeList_t &Nodes) const |
Retrieves all nodes in the node map. More... | |
GenApi::INode * | GetNode (const GenICam::gcstring &Name) const |
Retrieves the node from the central map by Name. More... | |
void | InvalidateNodes () const |
Invalidates all nodes. More... | |
void | Poll (int64_t ElapsedTime) |
Fires nodes which have a polling time. More... | |
Public Attributes | |
Root - Interface to the GigE specific stream parameters. | |
GenApi::IEnumerationT < TypeEnums > & | Type |
Selects the driver type to be used. More... | |
GenApi::IInteger & | MaxNumBuffer |
The maximum number of buffers that can be used simultaneously. More... | |
GenApi::IInteger & | MaxBufferSize |
The maximum buffer size in bytes that can be registered. More... | |
GenApi::IBoolean & | EnableResend |
Enables or disables the packet resend mechanism. More... | |
GenApi::IInteger & | PacketTimeout |
Timeout period in milliseconds between two packets within one frame. More... | |
GenApi::IBoolean & | AutoPacketSize |
Enables or disables probing of a working large packet size before grabbing. More... | |
GenApi::IInteger & | ReceiveWindowSize |
Size of the sliding receive window in number of frames. More... | |
GenApi::IInteger & | ResendRequestThreshold |
Resend threshold as percentage of receive window. More... | |
GenApi::IInteger & | ResendRequestBatching |
Additional resend batching as percentage of threshold. More... | |
GenApi::IInteger & | ResendTimeout |
Time in milliseconds to wait until a resend request is issued. More... | |
GenApi::IInteger & | ResendRequestResponseTimeout |
Timeout in milliseconds for missing resend responses. More... | |
GenApi::IInteger & | MaximumNumberResendRequests |
Maximum number of resend requests per packet. More... | |
GenApi::IInteger & | FrameRetention |
Maximum time in milliseconds to receive all packets of an individual frame. More... | |
GenApi::IBoolean & | ReceiveThreadPriorityOverride |
If enabled, the user can set a custom priority of the receive thread. More... | |
GenApi::IInteger & | ReceiveThreadPriority |
The realtime receive thread priority. More... | |
GenApi::IInteger & | SocketBufferSize |
The socket buffer size in KB. More... | |
Debug - Shows information for debugging purposes. | |
GenApi::IEnumerationT < StatusEnums > & | Status |
Shows the current stream grabber status. More... | |
GenApi::IEnumerationT < AccessModeEnums > & | AccessMode |
Camera access mode. More... | |
GenApi::IInteger & | TypeIsWindowsIntelPerformanceDriverAvailable |
Specifies whether the Pylon GigE Vision Performance Driver for Intel network controllers is currently available. More... | |
GenApi::IInteger & | TypeIsWindowsFilterDriverAvailable |
Specifies whether the Pylon GigE Vision Streaming Filter Driver is currently available. More... | |
GenApi::IInteger & | TypeIsSocketDriverAvailable |
Specifies whether the socket driver is currently available. More... | |
Statistic - Statistical data. | |
GenApi::IInteger & | Statistic_Total_Buffer_Count |
Counts the number of received frames. More... | |
GenApi::IInteger & | Statistic_Failed_Buffer_Count |
Counts the number of buffers with at least one failed packet (status != success). More... | |
GenApi::IInteger & | Statistic_Buffer_Underrun_Count |
Counts the number of frames lost because there were no buffers queued to the driver. More... | |
GenApi::IInteger & | Statistic_Total_Packet_Count |
Counts the number of received packets. More... | |
GenApi::IInteger & | Statistic_Failed_Packet_Count |
Counts the number of failed packets (status != success). More... | |
GenApi::IInteger & | Statistic_Resend_Request_Count |
Counts the number of emitted PACKETRESEND commands. More... | |
GenApi::IInteger & | Statistic_Resend_Packet_Count |
Counts the number of packets requested by PACKETRESEND commands. More... | |
IPConfig - Configuration of the stream destination. | |
GenApi::IEnumerationT < TransmissionTypeEnums > & | TransmissionType |
Controls whether the stream data is sent to a single device or to multiple devices. More... | |
GenApi::IString & | DestinationAddr |
Specifies the destination IP address. More... | |
GenApi::IInteger & | DestinationPort |
Specifies the destination port number (0 = auto select). More... | |
Low Level API: Class for pylon GigE Vision cameras providing access to stream grabber related methods and parameters.
|
inline |
Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber.
|
inline |
Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber.
|
inlineinherited |
Cancels pending requests.
, resources remain allocated. Following, the results must be retrieved from the Output Queue.
|
inlineinherited |
Closes the stream grabber.
Flushes the result queue and stops the thread.
|
inlineinherited |
Deregisters the buffer.
Deregistering fails while the buffer is in use, so retrieve the buffer from the output queue after grabbing.
|
inlineinherited |
Stops grabbing.
Releases the resources and camera. Pending grab requests are canceled.
|
inlineinherited |
Retrieves the node from the central map by Name.
|
inlineinherited |
Returns the associated stream grabber parameters.
If no parameters are available, NULL is returned.
|
inlineinherited |
Retrieves all nodes in the node map.
|
inlineinherited |
Returns the result event object.
This object is associated with the result queue. The event is signaled when queue is non-empty
|
inlineinherited |
Invalidates all nodes.
|
inlineinherited |
Retrieve whether the stream grabber is open.
|
inlineinherited |
Opens the stream grabber.
|
inlineinherited |
Fires nodes which have a polling time.
|
inlineinherited |
Prepares grabbing.
Allocates resources, synchronizes with the camera and locks critical parameter
|
inlineinherited |
Enqueues a buffer in the input queue.
PrepareGrab is required to queue buffers. The context is returned together with the buffer and the grab result. It is not touched by the stream grabber. It is illegal to queue a buffer a second time before it is fetched from the result queue.
|
inlineinherited |
Registers a buffer for subsequent use.
Stream must be locked to register buffers The Buffer size may not exceed the value specified when PrepareGrab was called.
|
inlineinherited |
Retrieves a grab result from the output queue.
|
inherited |
Camera access mode.
Visibility = Guru
|
inherited |
Enables or disables probing of a working large packet size before grabbing.
Enables or disables probing of a working large packet size before grabbing. Using large packets reduces the overhead for transferring images but whether a large packet can be transported depends on the used network hardware and its configuration.
Visibility = Guru
|
inherited |
Specifies the destination IP address.
The camera will sent all stream data to this IP address. For more details see 'TransmissionType' feature.
Visibility = Expert
|
inherited |
Specifies the destination port number (0 = auto select).
The camera will sent all stream data to this port.
Port configuration:
Visibility = Expert
|
inherited |
Enables or disables the packet resend mechanism.
An image frame consists of n numbers of packets. Each packet has a header consisting of a 24-bit packet ID. This packet ID increases with each packet sent, and makes it possible for the receiving end to know if a particular packet has been lost during the transfer. If 'ResendPacketMechanism' is enabled, and the receiving end notices a lost packet, it will request the other side (e.g. the camera) to send the lost packet again. If enabled, the 'ResendPacketMechanism' can cause delays in the timing because the sending end will resend the lost packet. If disabled, image data packet(s) can get lost which results in an incomplete received frame. You have to weigh the disadvantages and advantages for your special application to decide whether to enable or disable this command.
Default setting: Enabled
Visibility = Expert
|
inherited |
Maximum time in milliseconds to receive all packets of an individual frame.
An image frame consists of n numbers of packets. The 'FrameRetention' always starts from the point in time the receiving end notices that a packet has been received for a particular frame. If the transmission of packets of a frame is not completed within the 'FrameRetention' time, the corresponding frame is delivered with status 'Failed'.
Visibility = Guru
|
inherited |
The maximum buffer size in bytes that can be registered.
Visibility = Expert
|
inherited |
Maximum number of resend requests per packet.
Visibility = Guru
|
inherited |
The maximum number of buffers that can be used simultaneously.
Visibility = Expert
|
inherited |
Timeout period in milliseconds between two packets within one frame.
An image frame consists of n numbers of packets. The packet timeout counting is (re)started each time a packet is received. If the timeout expires (e.g. no packet was received during the last 'PacketTimeout' period), the 'Resend Packet Mechanism' is started. For information, see the 'EnableResend' feature.
Visibility = Guru
|
inherited |
The realtime receive thread priority.
This value sets the absolute thread priority of the receive thread.
Visibility = Guru
|
inherited |
If enabled, the user can set a custom priority of the receive thread.
Visibility = Guru
|
inherited |
Size of the sliding receive window in number of frames.
Visibility = Guru
|
inherited |
Additional resend batching as percentage of threshold.
Visibility = Guru
|
inherited |
Timeout in milliseconds for missing resend responses.
Visibility = Guru
|
inherited |
Resend threshold as percentage of receive window.
Visibility = Guru
|
inherited |
Time in milliseconds to wait until a resend request is issued.
Visibility = Guru
|
inherited |
The socket buffer size in KB.
Visibility = Guru
|
inherited |
Counts the number of frames lost because there were no buffers queued to the driver.
Visibility = Expert
|
inherited |
Counts the number of buffers with at least one failed packet (status != success).
Visibility = Expert
|
inherited |
Counts the number of failed packets (status != success).
Visibility = Expert
|
inherited |
Counts the number of packets requested by PACKETRESEND commands.
Visibility = Expert
|
inherited |
Counts the number of emitted PACKETRESEND commands.
Visibility = Expert
|
inherited |
Counts the number of received frames.
Visibility = Expert
|
inherited |
Counts the number of received packets.
Visibility = Expert
|
inherited |
Shows the current stream grabber status.
Visibility = Guru
|
inherited |
Controls whether the stream data is sent to a single device or to multiple devices.
Visibility = Expert
|
inherited |
Selects the driver type to be used.
Visibility = Beginner
|
inherited |
Specifies whether the socket driver is currently available.
Visibility = Guru
|
inherited |
Specifies whether the Pylon GigE Vision Streaming Filter Driver is currently available.
Visibility = Guru
|
inherited |
Specifies whether the Pylon GigE Vision Performance Driver for Intel network controllers is currently available.
Visibility = Guru