IDS peak genericC++  v1.7.1
peak::core Namespace Reference

The "core" namespace contains the direct GenAPI and GenTL wrapper. More...

Namespaces

 nodes
 The "nodes" namespace contains all GenAPI node types.
 

Classes

class  AbortedException
 The exception thrown for signaling an aborted operation. More...
 
class  BadAccessException
 The exception thrown for signaling an access error. More...
 
class  BadAllocException
 The exception thrown for signaling a failed memory allocation. More...
 
class  Buffer
 Represents a GenTL buffer module. More...
 
class  BufferChunk
 Represents a buffer chunk. More...
 
class  BufferPart
 Represents a buffer part. More...
 
class  CTILoadingException
 The exception thrown for signaling an error on opening a cti. More...
 
class  DataStream
 Represents a GenTL DataStream module. More...
 
class  DataStreamDescriptor
 Encapsulates the GenTL functions associated with a GenTL DataStream module's ID. More...
 
class  Device
 Represents a GenTL Device module, i.e. a local virtual Device proxy for the actual hardware RemoteDevice. More...
 
class  DeviceDescriptor
 Encapsulates the GenTL functions associated with a GenTL Device module's ID. More...
 
class  DeviceReconnectInformation
 
class  EnvironmentInspector
 Allows to inspect the environment the application is running in. More...
 
class  Event
 Encapsulates the GenTL event data functions. More...
 
class  EventController
 Encapsulates the GenTL event functionality associated with one GenTL Event handle. More...
 
class  EventSupportingModule
 The base class for all modules being able to raise events. More...
 
class  Exception
 The base class for all exceptions thrown by the library. More...
 
class  FirmwareUpdateInformation
 Represents a single firmware update information. More...
 
class  FirmwareUpdateProgressObserver
 Allows to observe a firmware update process. More...
 
class  FirmwareUpdater
 Allows to update the firmware of a device. More...
 
class  InitOnce
 
class  Interface
 Represents a GenTL Interface module. More...
 
class  InterfaceDescriptor
 Encapsulates the GenTL functions associated with a GenTL Interface module's ID. More...
 
class  InternalErrorException
 The exception thrown for internal errors. More...
 
class  InvalidAddressException
 The exception thrown for trying to work on an invalid address. More...
 
class  InvalidArgumentException
 The exception thrown for pass an invalid argument to a function. More...
 
class  InvalidCastException
 The exception thrown for trying to apply an invalid cast. More...
 
class  InvalidInstanceException
 The exception thrown for trying to work on an invalid instance. More...
 
class  IOException
 The exception thrown for a communication error. More...
 
class  Module
 Represents an extended GenTL port. More...
 
class  ModuleDescriptor
 The base class for all openable modules. More...
 
class  NodeMap
 Represents a GenAPI node map. More...
 
class  NotAvailableException
 The exception thrown for signaling a feature is not available in the device. More...
 
class  NotFoundException
 The exception thrown for signaling a failed find operation. More...
 
class  NotImplementedException
 The exception thrown for signaling a feature is not implemented. More...
 
class  NotInitializedException
 The exception thrown for signaling that the library was not initialized. More...
 
class  OutOfRangeException
 The exception thrown for trying to access a value being out of range. More...
 
class  Port
 Represents a GenTL port. More...
 
class  PortURL
 Represents a GenTL port URL. More...
 
class  ProducerLibrary
 Represents a GenTL producer library (CTI). More...
 
struct  RawInformation
 The struct returned by all raw information functions. More...
 
class  RemoteDevice
 Allows to access the physical Device. More...
 
class  System
 Represents a GenTL System module. More...
 
class  SystemDescriptor
 Encapsulates the GenTL functions associated with the GenTL System module's ID. More...
 
class  Timeout
 Represents a timeout value in milliseconds. More...
 
class  TimeoutException
 The exception thrown for signaling an exceeded timeout during a function call. More...
 
class  Version
 Implements versioning functionality. More...
 

Enumerations

enum  BufferPayloadType {
  BufferPayloadType::Unknown,
  BufferPayloadType::Image,
  BufferPayloadType::RawData,
  BufferPayloadType::File,
  BufferPayloadType::Chunk,
  BufferPayloadType::JPEG,
  BufferPayloadType::JPEG2000,
  BufferPayloadType::H264,
  BufferPayloadType::ChunkOnly,
  BufferPayloadType::DeviceSpecific,
  BufferPayloadType::MultiPart,
  BufferPayloadType::Custom = 1000
}
 Payload type of buffer. More...
 
enum  PixelFormatNamespace {
  PixelFormatNamespace::GEV = 1,
  PixelFormatNamespace::IIDC,
  PixelFormatNamespace::PFNC16Bit,
  PixelFormatNamespace::PFNC32Bit,
  PixelFormatNamespace::Custom = 1000
}
 The namespace needed to interpret the pixel format value of the buffer. More...
 
enum  BufferPartType {
  BufferPartType::Unknown,
  BufferPartType::Image2D,
  BufferPartType::PlaneBiPlanar2D,
  BufferPartType::PlaneTriPlanar2D,
  BufferPartType::PlaneQuadPlanar2D,
  BufferPartType::Image3D,
  BufferPartType::PlaneBiPlanar3D,
  BufferPartType::PlaneTriPlanar3D,
  BufferPartType::PlaneQuadPlanar3D,
  BufferPartType::ConfidenceMap,
  BufferPartType::Custom = 1000
}
 Data type of the buffer part. More...
 
enum  Endianness {
  Endianness::Unknown,
  Endianness::Little,
  Endianness::Big
}
 Endianness of pixel data in a Buffer or the data in a Port. More...
 
enum  DataStreamFlushMode {
  DataStreamFlushMode::InputPoolToOutputQueue,
  DataStreamFlushMode::DiscardOutputQueue,
  DataStreamFlushMode::AllToInputPool,
  DataStreamFlushMode::UnqueuedToInputPool,
  DataStreamFlushMode::DiscardAll,
  DataStreamFlushMode::Custom = 1000
}
 Operation modes for DataStream::Flush() method. More...
 
enum  AcquisitionStartMode {
  AcquisitionStartMode::Default,
  AcquisitionStartMode::Custom = 1000
}
 The enum holding the possible acquisition start modes, for DataStream::StartAcquisition(). More...
 
enum  AcquisitionStopMode {
  AcquisitionStopMode::Default,
  AcquisitionStopMode::Kill,
  AcquisitionStopMode::Custom = 1000
}
 The enum holding the possible acquisition stop modes, for DataStream::StopAcquisition(). More...
 
enum  DeviceAccessStatus {
  DeviceAccessStatus::ReadWrite = 1,
  DeviceAccessStatus::ReadOnly,
  DeviceAccessStatus::NoAccess,
  DeviceAccessStatus::Busy,
  DeviceAccessStatus::OpenReadWrite,
  DeviceAccessStatus::OpenReadOnly,
  DeviceAccessStatus::Custom = 1000
}
 Current accessibility of the device. More...
 
enum  DeviceAccessType {
  DeviceAccessType::ReadOnly = 2,
  DeviceAccessType::Control,
  DeviceAccessType::Exclusive,
  DeviceAccessType::Custom = 1000
}
 Different modes to open the device with. More...
 
enum  DeviceInformationRole {
  DeviceInformationRole::ID = 0,
  DeviceInformationRole::VendorName,
  DeviceInformationRole::ModelName,
  DeviceInformationRole::TLType,
  DeviceInformationRole::DisplayName,
  DeviceInformationRole::AccessStatus,
  DeviceInformationRole::UserDefinedName,
  DeviceInformationRole::SerialNumber,
  DeviceInformationRole::Version,
  DeviceInformationRole::TimestampTickFrequency,
  DeviceInformationRole::Custom = 1000
}
 Different types of information about the device. More...
 
enum  FirmwareUpdatePersistence {
  FirmwareUpdatePersistence::None,
  FirmwareUpdatePersistence::Full
}
 Specifies if the device persists user sets and/or sequencer sets during the update. More...
 
enum  FirmwareUpdateVersionStyle {
  FirmwareUpdateVersionStyle::Dotted,
  FirmwareUpdateVersionStyle::Semantic
}
 The style of the version value. More...
 
enum  FirmwareUpdateStep {
  FirmwareUpdateStep::CheckPreconditions,
  FirmwareUpdateStep::AcquireUpdateData,
  FirmwareUpdateStep::WriteFeature,
  FirmwareUpdateStep::ExecuteFeature,
  FirmwareUpdateStep::AssertFeature,
  FirmwareUpdateStep::UploadFile,
  FirmwareUpdateStep::ResetDevice
}
 The possible firmware update step types. More...
 
enum  EventType {
  EventType::Error,
  EventType::FeatureInvalidate = 2,
  EventType::FeatureChange,
  EventType::RemoteDevice,
  EventType::Module,
  EventType::Custom = 1000
}
 Different types of events. More...
 
enum  PortURLScheme {
  PortURLScheme::Local,
  PortURLScheme::HTTP,
  PortURLScheme::File,
  PortURLScheme::Custom = 1000
}
 Possible URL schemes for the port. More...
 
enum  CharacterEncoding {
  CharacterEncoding::ASCII = 0,
  CharacterEncoding::UTF8
}
 Possible character encodings. More...
 

Functions

std::string ToString (BufferPayloadType entry)
 
std::string ToString (PixelFormatNamespace entry)
 
std::string ToString (BufferPartType entry)
 
std::string ToString (Endianness entry)
 
std::string ToString (DataStreamFlushMode entry)
 
std::string ToString (AcquisitionStartMode entry)
 
std::string ToString (AcquisitionStopMode entry)
 
std::string ToString (DeviceAccessStatus entry)
 
std::string ToString (DeviceAccessType entry)
 
std::string ToString (DeviceInformationRole entry)
 
std::string ToString (FirmwareUpdatePersistence entry)
 
std::string ToString (FirmwareUpdateVersionStyle entry)
 
std::string ToString (FirmwareUpdateStep entry)
 
std::string ToString (EventType entry)
 
std::string ToString (PortURLScheme entry)
 
std::string ToString (CharacterEncoding entry)
 
bool operator< (const Version &lhs, const Version &rhs)
 
bool operator> (const Version &lhs, const Version &rhs)
 
bool operator== (const Version &lhs, const Version &rhs)
 
bool operator!= (const Version &lhs, const Version &rhs)
 

Detailed Description

The "core" namespace contains the direct GenAPI and GenTL wrapper.

Enumeration Type Documentation

◆ AcquisitionStartMode

The enum holding the possible acquisition start modes, for DataStream::StartAcquisition().

See GenTL ACQ_START_FLAGS.

Enumerator
Default 

Default behavior.

Custom 

Starting value for GenTL Producer custom IDs which are implementation specific.

◆ AcquisitionStopMode

The enum holding the possible acquisition stop modes, for DataStream::StopAcquisition().

See GenTL ACQ_STOP_FLAGS.

Enumerator
Default 

Stops the acquisition engine when the currently running tasks like filling a buffer are completed (default behavior).

Kill 

Stop the acquisition engine immediately. In case this results in a partially filled buffer the Producer will return the buffer through the regular mechanism to the user, indicating through the info function of that buffer that this buffer is not complete.

Custom 

Starting value for GenTL Producer custom IDs which are implementation specific.

◆ BufferPartType

Data type of the buffer part.

See GenTL PARTDATATYPE_IDS.

Enumerator
Unknown 
Image2D 
PlaneBiPlanar2D 
PlaneTriPlanar2D 
PlaneQuadPlanar2D 
Image3D 
PlaneBiPlanar3D 
PlaneTriPlanar3D 
PlaneQuadPlanar3D 
ConfidenceMap 
Custom 

◆ BufferPayloadType

Payload type of buffer.

See GenTL PAYLOADTYPE_INFO_IDS.

Enumerator
Unknown 
Image 
RawData 
File 
Chunk 
JPEG 
JPEG2000 
H264 
ChunkOnly 
DeviceSpecific 
MultiPart 
Custom 

◆ CharacterEncoding

Possible character encodings.

See GenTL TL_CHAR_ENCODING_LIST.

Enumerator
ASCII 
UTF8 

◆ DataStreamFlushMode

Operation modes for DataStream::Flush() method.

See GenTL ACQ_QUEUE_TYPE.

Enumerator
InputPoolToOutputQueue 

Flushes the buffers from the input pool to the output buffer queue and if necessary adds entries in the "New Buffer" event data queue. The buffers currently being filled are not affected by this operation.

DiscardOutputQueue 

Discards all buffers in the output buffer queue and if necessary remove the entries from the event data queue.

AllToInputPool 

Puts all buffers in the input pool. This is including those in the output buffer queue and the ones which are currently being filled and discard entries in the event data queue.

UnqueuedToInputPool 

Puts all buffers that are neither in the input pool nor being currently filled nor in the output buffer queue in the input pool.

DiscardAll 

Discards all buffers in the input pool and the buffers in the output queue including buffers currently being filled so that no buffer is bound to any internal mechanism and all buffers may be revoked or requeued.

Custom 

Starting value for GenTL Producer custom IDs which are implementation specific.

◆ DeviceAccessStatus

Current accessibility of the device.

See GenTL DEVICE_ACCESS_STATUS.

Enumerator
ReadWrite 
ReadOnly 
NoAccess 
Busy 
OpenReadWrite 
OpenReadOnly 
Custom 

◆ DeviceAccessType

Different modes to open the device with.

See GenTL DEVICE_ACCESS_FLAGS.

Enumerator
ReadOnly 
Control 
Exclusive 
Custom 

◆ DeviceInformationRole

Different types of information about the device.

See GenTL DEVICE_INFO_CMD.

Enumerator
ID 
VendorName 
ModelName 
TLType 
DisplayName 
AccessStatus 
UserDefinedName 
SerialNumber 
Version 
TimestampTickFrequency 
Custom 

◆ Endianness

Endianness of pixel data in a Buffer or the data in a Port.

See GenTL PIXELENDIANNESS_IDS.

Enumerator
Unknown 

Endianness of the data is unknown to the GenTL Producer.

Little 

The data is stored in little endian format.

Big 

The data is stored in big endian format.

◆ EventType

enum peak::core::EventType
strong

Different types of events.

See GenTL EVENT_TYPE.

GenTL EVENT_NEW_BUFFER is missing, since new buffer events are handled via DataStream::WaitForFinishedBuffer().

Enumerator
Error 
FeatureInvalidate 
FeatureChange 
RemoteDevice 
Module 
Custom 

◆ FirmwareUpdatePersistence

Specifies if the device persists user sets and/or sequencer sets during the update.

Enumerator
None 

All sets are reset to default values during the update.

Full 

The device guarantees, that all sets are persisted during the update.

◆ FirmwareUpdateStep

The possible firmware update step types.

Enumerator
CheckPreconditions 
AcquireUpdateData 
WriteFeature 
ExecuteFeature 
AssertFeature 
UploadFile 
ResetDevice 

◆ FirmwareUpdateVersionStyle

The style of the version value.

This is needed to actually interpret and sort the versions. Using this information an update software is able to inform the user if an update would actually be a downgrade or if it was already applied to the device.

Enumerator
Dotted 

The version consists of any number of parts separated by dots. If a part consists of decimal characters only, it is compared numerically, otherwise it is compared using strcmp(). This leads to the following ordering: 1.1.a < 1.10.a < 1.10.b <1.10.b.a

Semantic 

The style as specified in 'Semantic Versioning 2.0.0' ( http://semver.org/ ).

◆ PixelFormatNamespace

The namespace needed to interpret the pixel format value of the buffer.

See GenTL PIXELFORMAT_NAMESPACE_IDS.

Enumerator
GEV 
IIDC 
PFNC16Bit 
PFNC32Bit 
Custom 

◆ PortURLScheme

Possible URL schemes for the port.

See GenTL URL_SCHEME_IDS.

Enumerator
Local 
HTTP 
File 
Custom 

Function Documentation

◆ operator!=()

bool peak::core::operator!= ( const Version &  lhs,
const Version &  rhs 
)
inline

◆ operator<()

bool peak::core::operator< ( const Version &  lhs,
const Version &  rhs 
)
inline

◆ operator==()

bool peak::core::operator== ( const Version &  lhs,
const Version &  rhs 
)
inline

◆ operator>()

bool peak::core::operator> ( const Version &  lhs,
const Version &  rhs 
)
inline

◆ ToString() [1/16]

std::string peak::core::ToString ( CharacterEncoding  entry)
inline

◆ ToString() [2/16]

std::string peak::core::ToString ( DeviceAccessStatus  entry)
inline

◆ ToString() [3/16]

std::string peak::core::ToString ( Endianness  entry)
inline

◆ ToString() [4/16]

std::string peak::core::ToString ( EventType  entry)
inline

◆ ToString() [5/16]

std::string peak::core::ToString ( BufferPartType  entry)
inline

◆ ToString() [6/16]

std::string peak::core::ToString ( FirmwareUpdateStep  entry)
inline

◆ ToString() [7/16]

std::string peak::core::ToString ( FirmwareUpdatePersistence  entry)
inline

◆ ToString() [8/16]

std::string peak::core::ToString ( PortURLScheme  entry)
inline

◆ ToString() [9/16]

std::string peak::core::ToString ( FirmwareUpdateVersionStyle  entry)
inline

◆ ToString() [10/16]

std::string peak::core::ToString ( DeviceAccessType  entry)
inline

◆ ToString() [11/16]

std::string peak::core::ToString ( DeviceInformationRole  entry)
inline

◆ ToString() [12/16]

std::string peak::core::ToString ( BufferPayloadType  entry)
inline

◆ ToString() [13/16]

std::string peak::core::ToString ( PixelFormatNamespace  entry)
inline

◆ ToString() [14/16]

std::string peak::core::ToString ( DataStreamFlushMode  entry)
inline

◆ ToString() [15/16]

std::string peak::core::ToString ( AcquisitionStartMode  entry)
inline

◆ ToString() [16/16]

std::string peak::core::ToString ( AcquisitionStopMode  entry)
inline