Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvResult::Code Struct Reference

Public Types

enum  CodeEnum {
  OK = 0, NOT_INITIALIZED = 0x0605, NOT_FOUND = 0x0019, CANNOT_OPEN_FILE = 0x0006,
  NO_MORE_ITEM = 0x0015, NOT_CONNECTED = 0x0017, STATE_ERROR = 0x001c, THREAD_ERROR = 0x001d,
  INVALID_DATA_FORMAT = 0x0501, ABORTED = 0x0001, NOT_ENOUGH_MEMORY = 0x0018, GENERIC_ERROR = 0x4000,
  INVALID_PARAMETER = 0x4001, CANCEL = 0x4002, PENDING = 0xffff, TIMEOUT = 0x001e,
  NO_LICENSE = 0x0602, GENICAM_XML_ERROR = 0x0904, CANT_READ_MANIFEST = 0x0905, NOT_IMPLEMENTED = 0x0604,
  NOT_SUPPORTED = 0x001a, FILE_ERROR = 0x0010, ERR_OVERFLOW = 0x001b, IMAGE_ERROR = 0x0025,
  MISSING_PACKETS = 0x0027, BUFFER_TOO_SMALL = 0x0004, TOO_MANY_RESENDS = 0x0b00, RESENDS_FAILURE = 0x0b01,
  TOO_MANY_CONSECUTIVE_RESENDS = 0x0b03, AUTO_ABORTED = 0x0b02, BAD_VERSION = 0x0201, NO_MORE_ENTRY = 0x0603,
  NO_AVAILABLE_DATA = 0x0014, NETWORK_ERROR = 0x0013, RESYNC = 0x0028, BUSY = 0x0202,
  CORRUPTED_DATA = 0x0303
}
 

Detailed Description

Container to restrict scope of PvResult::Code::CodeEnum

Member Enumeration Documentation

◆ CodeEnum

Enumerator
OK 

Success! (Immediate.)

NOT_INITIALIZED 

An error code hasn't been set.

When initially created (using PvResult::PvResult), the PvResult object has the value NOT_INITIALIZED.

The value only occurs when the object is first created; no method returns NOT_INITIALIZED.

NOT_FOUND 

The expected item wasn't found.

Possible causes include:

  • Connecting to a GigE Vision device that doesn't exist (or isn't on the network).
  • Accessing a non-existent parameter.
CANNOT_OPEN_FILE 

The file doesn't exist or can't be opened.

NO_MORE_ITEM 

No more of what was requested is currently available.

NOT_CONNECTED 

The object (PvDevice or PvStream object) isn't connected.

Refer to the documentation of the method being called or call PvResult::GetDescription for further information.

STATE_ERROR 

The method is (probably) legal, but the system's current state doesn't allow the action.

For example, you can't queue buffers to a stream (using PvStream::QueueBuffer) before opening it (using PvStream::Open).

THREAD_ERROR 

An error occurred while attempting to perform an operation on a thread like starting, stopping or changing priority.

INVALID_DATA_FORMAT 

The data format is not supported for the requested operation.

ABORTED 

The operation was aborted

NOT_ENOUGH_MEMORY 

Not enough memory.

An operation failed to complete as not enough memory was available.

GENERIC_ERROR 

An undefined error occurred.

Refer to the documentation of the method being called or call PvResult::GetDescription for further information.

INVALID_PARAMETER 

A parameter passed to the method is invalid.

Possible causes include:

  • A value is out-of-bounds.
  • An empty string, where a non-empty string is required.
  • A null pointer.
CANCEL 

The user closed a dialog and the operation was not performed

This can occur if the "Cancel" button is clicked.

PENDING 

Success! (Pending.)

Returned by PvStream::QueueBuffer to indicate that a buffer has been successfully queued but the operation is still pending (the data has not yet been received).

TIMEOUT 

The operation timed out.

The operation exceeded its specified maximum wait time without succeeding.

NO_LICENSE 

An eBUS SDK license is missing.

To receive data from a GigE Vision device that does not contain a Pleora video interface, a receiver license is required. A license is also required to transmit data using the eBUS SDK using PvTransmitterGEV. When working with images, a watermark is applied when no license is present. This is so that the SDK can be used for evaluation purposes.

GENICAM_XML_ERROR 

The GenICam XML file could not be loaded into GenApi.

The file could be corrupted or simply incorrectly structured. Some third-party vendors use XML files that don't conform to the GenApi schema.

CANT_READ_MANIFEST 

The manifest table of the device could not be read

Device was discovered but the manifest table could not be read. It may have a corrupt firmware load or could be powered incorrectly.

NOT_IMPLEMENTED 

The requested feature or functionality is not implemented.

Can happen when a dynamically selected feature or capability is not implemented in the SDK.

NOT_SUPPORTED 

The requested feature or functionality is not supported.

FILE_ERROR 

A file operation error occured.

ERR_OVERFLOW 

Overflow occurred.

Can happen when a counter overflows or when an attempt was made to write past the upper boundary of a file or data structure.

IMAGE_ERROR 

Error with an image.

May be returned when a corrupt image arrives due to discontinuities in data between the camera and the hardware responsible for transmitting packets in the GigE Vision device. This can include data overrun, partial and full lines missing.

MISSING_PACKETS 

Some packets are missing in the buffer.

Happens when at least one packet of the buffer is missing when it was released back to the calling application.

BUFFER_TOO_SMALL 

The buffer was not large enough to hold the payload of the block being received

Call PvBuffer::GetRequiredSize to use the information from the leader packet to determine the size of buffer that would have been required to receive the block. Call PvBuffer::Alloc or PvBuffer::Attach to allocate or associate an a larger area of memory to receive the next block.

TOO_MANY_RESENDS 

Too many resend packets were requested, buffer acquisition failure.

RESENDS_FAILURE 

Failure to receive all missing packets for a buffer through resend packets.

TOO_MANY_CONSECUTIVE_RESENDS 

Buffer reception failed, consecutive missing buffers higher than allowed.

The data receiver may stop attempting to receive a block if a set of consecutive packets exceeding MaximumResendGroupSize.

AUTO_ABORTED 

Buffer reception failed.

The data receiver entered a state where so many packets and/or blocks were missing that all queued buffers were automatically aborted on an internal reset.

BAD_VERSION 

Some component versions are not compatible.

NO_MORE_ENTRY 

There are no more entries to retrieve/enumerate.

NO_AVAILABLE_DATA 

There is no available data to enumerate.

NETWORK_ERROR 

A network error occurred while performing the requested operation.

RESYNC 

Kick out of the driver because of a forced resynchronisation.

BUSY 

The resource requested is already in use.

CORRUPTED_DATA 

The data is corrupted.


The documentation for this struct was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com