#include <EGenTL.h>

Public Member Functions
	EGenTL (const std::string &path=Internal::getEuresysCtiPath(), bool shared=true)
	Initializes the EGenTL library. More...

	EGenTL (const char *path, bool shared=true)

	EGenTL (bool shared, const std::string &path=Internal::getEuresysCtiPath())

virtual	~EGenTL ()

template<typename T >
T	gcGetInfo (gc::TL_INFO_CMD cmd)
	Retrieves numerical information for the system module. More...

bool	isShared () const

void	eventKillQuiet (gc::EVENT_HANDLE eh)

void	lockUpdates ()

void	unlockUpdates ()

Low-level GenTL Port functions
void	gcReadPort (gc::PORT_HANDLE ph, uint64_t address, std::vector< char > &data)
	Fills `data` with `data.size` bytes from `ph` 's registers space. More...

std::string	gcReadPortString (gc::PORT_HANDLE ph, uint64_t address, size_t size)
	Reads up to `size` bytes from `ph` 's registers space as a string. More...

uint32_t	gcReadPort (gc::PORT_HANDLE ph, uint64_t address)
	Reads a single 32-bit value from `ph` 's registers space. More...

void	gcWritePort (gc::PORT_HANDLE ph, uint64_t address, const std::vector< char > &data)
	Writes `data.size` bytes into `ph` 's registers space. More...

void	gcReadPortData (gc::PORT_HANDLE ph, uint64_t address, void *data, size_t size)
	Read data from port. More...

void	gcWritePortData (gc::PORT_HANDLE ph, uint64_t address, const void *data, size_t size)
	Write data to port. More...

std::vector< std::string >	gcGetPortURL (gc::PORT_HANDLE ph)
	Returns the list of XML description URL for the given port. More...

template<typename T >
T	gcGetPortInfo (gc::PORT_HANDLE ph, gc::PORT_INFO_CMD cmd)
	retrieve numerical information for a port module. More...

GenTL Event functions
gc::EVENT_HANDLE	gcRegisterEvent (gc::EVENTSRC_HANDLE h, gc::EVENT_TYPE event)
	Returns the handle to a newly registered event. More...

void	gcUnregisterEvent (gc::EVENTSRC_HANDLE h, gc::EVENT_TYPE event)

size_t	eventGetData (gc::EVENT_HANDLE eh, void *buffer, size_t size, uint64_t timeout)
	Waits for event to happen for at most `timeout` ms and returns filled data size. More...

void	eventsGetData (std::vector< ge::EURESYS_EVENT_GET_DATA_ENTRY > &entries, uint64_t *timeout)
	Waits for multiple events to happen for at most `timeout` ms. More...

template<typename T >
T	eventGetDataInfo (gc::EVENT_HANDLE eh, const void *buffer, size_t size, gc::EVENT_DATA_INFO_CMD cmd)
	Retrieves numerical information for an event data given in buffer. More...

template<typename T >
T	eventGetInfo (gc::EVENT_HANDLE eh, gc::EVENT_INFO_CMD cmd)
	Retrieves numerical information for an event. More...

void	eventFlush (gc::EVENT_HANDLE eh)
	Discards all the past occurrences. More...

void	eventKill (gc::EVENT_HANDLE eh)
	Terminates a pending operation. More...

GenTL TL functions
gc::TL_HANDLE	tlOpen ()

void	tlClose (gc::TL_HANDLE tlh)

template<typename T >
T	tlGetInfo (gc::TL_HANDLE tlh, gc::TL_INFO_CMD cmd)
	Retrieves numerical information for the TL module. More...

uint32_t	tlGetNumInterfaces (gc::TL_HANDLE tlh)

std::string	tlGetInterfaceID (gc::TL_HANDLE tlh, uint32_t index)

template<typename T >
T	tlGetInterfaceInfo (gc::TL_HANDLE tlh, const std::string &ifID, gc::TL_INFO_CMD cmd)
	Retrieves numerical information for the Interface module identified by its ID. More...

gc::IF_HANDLE	tlOpenInterface (gc::TL_HANDLE tlh, const std::string &ifID)

bool	tlUpdateInterfaceList (gc::TL_HANDLE tlh, uint64_t timeout=GENTL_INFINITE)
	Checks whether the list of interface modules has changed. More...

GenTL Interface functions
void	ifClose (gc::IF_HANDLE ifh)

template<typename T >
T	ifGetInfo (gc::IF_HANDLE ifh, gc::INTERFACE_INFO_CMD cmd)
	Retrieves numerical information for the Interface module. More...

uint32_t	ifGetNumDevices (gc::IF_HANDLE ifh)

std::string	ifGetDeviceID (gc::IF_HANDLE ifh, uint32_t index)

bool	ifUpdateDeviceList (gc::IF_HANDLE ifh, uint64_t timeout=GENTL_INFINITE)
	Checks whether the list of devices has changed. More...

template<typename T >
T	ifGetDeviceInfo (gc::IF_HANDLE ifh, const std::string &devID, gc::INTERFACE_INFO_CMD cmd)
	Retrieves numerical information for the Device module identified by its ID. More...

gc::DEV_HANDLE	ifOpenDevice (gc::IF_HANDLE ifh, const std::string &devID, gc::DEVICE_ACCESS_FLAGS flags=defaultDeviceOpenFlags)

GenTL Device functions
gc::PORT_HANDLE	devGetPort (gc::DEV_HANDLE devh)

uint32_t	devGetNumDataStreams (gc::DEV_HANDLE devh)

std::string	devGetDataStreamID (gc::DEV_HANDLE devh, uint32_t index)

gc::DS_HANDLE	devOpenDataStream (gc::DEV_HANDLE devh, const std::string &dsID)

void	devClose (gc::DEV_HANDLE devh)

template<typename T >
T	devGetInfo (gc::DEV_HANDLE devh, gc::DEVICE_INFO_CMD cmd)
	Retrieves numerical information for the Device module. More...

GenTL DataStream functions
gc::BUFFER_HANDLE	dsAnnounceBuffer (gc::DS_HANDLE dsh, void buffer, size_t size, void userPointer=0)
	Gets the handle of a new DataStream buffer allocated by the user. More...

gc::BUFFER_HANDLE	dsAllocAndAnnounceBuffer (gc::DS_HANDLE dsh, size_t size, void *userPointer=0)
	Gets the handle of a new DataStream buffer allocated automatically. More...

gc::BUFFER_HANDLE	dsAnnounceBusBuffer (gc::DS_HANDLE dsh, uint64_t busAddress, size_t size, void *userPointer=0)
	Gets the handle of a new DataStream buffer allocated by the user and addressable on the PCIe bus. More...

void	dsAllocAndAnnounceBuffers (gc::DS_HANDLE dsh, size_t size, std::vector< gc::BUFFER_HANDLE > &buffers)
	Fills `buffers` vector with `buffers.size` handles to newly allocated buffers. More...

void	dsFlushQueue (gc::DS_HANDLE dsh, gc::ACQ_QUEUE_TYPE operation)
	Flushes a buffers pool/queue. More...

void	dsStartAcquisition (gc::DS_HANDLE dsh, gc::ACQ_START_FLAGS flags=gc::ACQ_START_FLAGS_DEFAULT, uint64_t count=GENTL_INFINITE)
	Declares the DataStream ready for acquisition. More...

void	dsStopAcquisition (gc::DS_HANDLE dsh, gc::ACQ_STOP_FLAGS flags=gc::ACQ_STOP_FLAGS_DEFAULT)
	Declares the DataStream as done with acquisition. More...

void	dsClose (gc::DS_HANDLE dsh)

template<typename T >
T	dsGetInfo (gc::DS_HANDLE dsh, gc::STREAM_INFO_CMD cmd)
	Retrieves numerical information for the DataStream module. More...

gc::BUFFER_HANDLE	dsGetBufferID (gc::DS_HANDLE dsh, uint32_t index)

void	dsRevokeBuffer (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh, void buffer=0, void userPointer=0)

void	dsRevokeBuffers (gc::DS_HANDLE dsh, std::vector< gc::BUFFER_HANDLE > &buffers)
	Revokes the buffers contained in the `buffers` vector. More...

void	dsQueueBuffer (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh)
	Adds a buffer to the input buffer queue. More...

void	dsQueueBuffers (gc::DS_HANDLE dsh, const std::vector< gc::BUFFER_HANDLE > &buffers)
	Adds the buffers contained in the `buffers` vector to the input buffer queue. More...

template<typename T >
T	dsGetBufferInfo (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh, gc::BUFFER_INFO_CMD cmd)
	Retrieves numerical information for a buffer. More...

BufferInfo	dsGetBufferInfo (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh)
	Retrieves useful buffer information in one operation. More...

uint32_t	dsGetNumBufferParts (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh)

template<typename T >
T	dsGetBufferPartInfo (gc::DS_HANDLE dsh, gc::BUFFER_HANDLE bh, uint32_t index, gc::BUFFER_PART_INFO_CMD cmd)
	Retrieves numerical information for a buffer part. More...

uint32_t	gcGetNumPortURLs (gc::PORT_HANDLE h)

template<typename T >
T	gcGetPortURLInfo (gc::PORT_HANDLE h, uint32_t index, gc::URL_INFO_CMD cmd)

void	gcReadPortStacked (gc::PORT_HANDLE h, std::vector< gc::PORT_REGISTER_STACK_ENTRY > &entries)
	Reads a number of bytes from the given address on the specified port for every element in the entries vector. More...

void	gcWritePortStacked (gc::PORT_HANDLE h, std::vector< gc::PORT_REGISTER_STACK_ENTRY > &entries)
	Writes a number of bytes to the given address on the specified port for every element in the entries vector. More...

gc::TL_HANDLE	ifGetParent (gc::IF_HANDLE ifh)

gc::IF_HANDLE	devGetParent (gc::DEV_HANDLE devh)

gc::DEV_HANDLE	dsGetParent (gc::DS_HANDLE dsh)

Euresys Memento functions
void	memento (const std::string &text)
	Reports a string to the memento logging system. More...

void	memento (unsigned char verbosity, unsigned char kind, const std::string &text)

Euresys Genapi functions
void	genapiSetString (gc::PORT_HANDLE h, const std::string &feature, const std::string &value)
	Updates a feature with string contents. More...

std::string	genapiGetString (gc::PORT_HANDLE h, const std::string &feature)
	Reads a feature as string. More...

void	genapiGetStringData (gc::PORT_HANDLE h, const std::string &feature, std::vector< char > &data)
	Reads a feature into a vector, the size of the vector is updated. More...

std::vector< std::string >	genapiGetStringList (gc::PORT_HANDLE h, const std::string &what)
	Reads a list of strings. More...

void	genapiSetInteger (gc::PORT_HANDLE h, const std::string &feature, int64_t value)
	Updates a feature with integer value. More...

int64_t	genapiGetInteger (gc::PORT_HANDLE h, const std::string &feature)
	Reads a feature as an integer. More...

int64_t	genapiGetIntegerWithDefault (gc::PORT_HANDLE h, const std::string &feature, int64_t defaultValue)
	Reads a feature as an integer. More...

void	genapiSetFloat (gc::PORT_HANDLE h, const std::string &feature, double value)
	Updates a feature with float value. More...

double	genapiGetFloat (gc::PORT_HANDLE h, const std::string &feature)
	Reads a feature as a float. More...

double	genapiGetFloatWithDefault (gc::PORT_HANDLE h, const std::string &feature, double defaultValue)
	Reads a feature as a float. More...

void	genapiExecuteCommand (gc::PORT_HANDLE h, const std::string &feature)
	Executes a GenApi command. More...

void	genapiAttachEvent (gc::PORT_HANDLE h, uint64_t eventId, const void *buffer, size_t size)
	Attach a GenApi event. More...

void	genapiRunScript (gc::PORT_HANDLE h, const std::string &script, ge::GENAPI_UI_SCRIPT_CONTEXT *context=0)
	Run a Euresys GenApi script. More...

void	genapiRunScript (const std::vector< gc::PORT_HANDLE > &handles, const std::string &script, ge::GENAPI_UI_SCRIPT_CONTEXT *context=0)
	Run a Euresys GenApi script. More...

void	genapiInterruptScript (const std::string &scriptId)
	Interrupt a running Euresys GenApi script. More...

Euresys Image functions
unsigned int	imageGetPixelFormatValue (const std::string &format, unsigned int ns)
	Get PFNC value from name. More...

std::string	imageGetPixelFormat (uint64_t format)

unsigned int	imageGetBytesPerPixel (const std::string &format)
	Get Bytes per pixel. More...

unsigned int	imageGetBitsPerPixel (const std::string &format)
	Get Bits per pixel. More...

void	imageConvert (const ge::ImageConvertInput &input, const ge::ImageConvertOutput &output, const ge::ImageConvertROI *roi)
	Convert an image. More...

void	imageSaveToDisk (const ge::ImageConvertInput &input, const std::string &filepath, int64_t index=-1, const ge::ImageSaveToDiskParams *params=0)
	Save an image to disk. More...

void *	imageGet (ge::ImageId id, size_t *outSize=0)
	Get information of an image. More...

void	imageRelease (ge::ImageId id)
	Release an image. More...

Public Attributes
ETraceContext &	traceCtx

Detailed Description

GenTL library functions

Exceptions

gentl_error on return codes other than GenTL::GC_ERR_SUCCESS. The error code can then be found in gentl_error.gc_err .

Constructor & Destructor Documentation

EGenTL	(	const std::string &	path = `Internal::getEuresysCtiPath()`,
		bool	shared = `true`
	)

Initializes the EGenTL library.

path: filesystem path to the EGenTL library.
shared: shared mode allows multiple opens of TL/IF/DEV handles. when shared is false, EGenTL behaves as specified in the GenTL standard, i.e. opening an already opened TL, interface, or device will throw a gentl_error (GenTL::GC_ERR_RESOURCE_IN_USE).

EGenTL	(	const char *	path,
		bool	shared = `true`
	)

EGenTL	(	bool	shared,
		const std::string &	path = `Internal::getEuresysCtiPath()`
	)

virtual ~EGenTL ( )

virtual

Member Function Documentation

T gcGetInfo ( gc::TL_INFO_CMD cmd )

inline

Retrieves numerical information for the system module.

See GenTL::TL_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

void gcReadPort	(	gc::PORT_HANDLE	ph,
		uint64_t	address,
		std::vector< char > &	data
	)

inline

Fills data with data.size bytes from ph 's registers space.

values at [address .. address+data.size[ will be read.

Exceptions

unexpected_data_size if the vector couldn't be filled.

std::string gcReadPortString	(	gc::PORT_HANDLE	ph,
		uint64_t	address,
		size_t	size
	)

inline

Reads up to size bytes from ph 's registers space as a string.

uint32_t gcReadPort	(	gc::PORT_HANDLE	ph,
		uint64_t	address
	)

inline

Reads a single 32-bit value from ph 's registers space.

void gcWritePort	(	gc::PORT_HANDLE	ph,
		uint64_t	address,
		const std::vector< char > &	data
	)

inline

Writes data.size bytes into ph 's registers space.

Exceptions

unexpected_data_size if some bytes couldn't be sent.

void gcReadPortData	(	gc::PORT_HANDLE	ph,
		uint64_t	address,
		void *	data,
		size_t	size
	)

inline

Read data from port.

Exceptions

unexpected_data_size if all requested bytes could not be read.

void gcWritePortData	(	gc::PORT_HANDLE	ph,
		uint64_t	address,
		const void *	data,
		size_t	size
	)

inline

Write data to port.

Exceptions

unexpected_data_size if all given bytes could not be written.

std::vector<std::string> gcGetPortURL ( gc::PORT_HANDLE ph )

inline

Returns the list of XML description URL for the given port.

T gcGetPortInfo	(	gc::PORT_HANDLE	ph,
		gc::PORT_INFO_CMD	cmd
	)

inline

retrieve numerical information for a port module.

See GenTL::PORT_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

gc::EVENT_HANDLE gcRegisterEvent	(	gc::EVENTSRC_HANDLE	h,
		gc::EVENT_TYPE	event
	)

inline

Returns the handle to a newly registered event.

h: the source module handle (e.g. a GenTL::DS_HANDLE)

void gcUnregisterEvent	(	gc::EVENTSRC_HANDLE	h,
		gc::EVENT_TYPE	event
	)

inline

size_t eventGetData	(	gc::EVENT_HANDLE	eh,
		void *	buffer,
		size_t	size,
		uint64_t	timeout
	)

inline

Waits for event to happen for at most timeout ms and returns filled data size.

Exceptions

gentl_error on timeout or termination through eventKill.

void eventsGetData	(	std::vector< ge::EURESYS_EVENT_GET_DATA_ENTRY > &	entries,
		uint64_t *	timeout
	)

inline

Waits for multiple events to happen for at most timeout ms.

Exceptions

gentl_error on timeout (unless timeout is NULL) or termination through eventKill.

Warning: see documentation of underlying function GenTL::EuresysCustomGenTL::EuresysEventsGetData

T eventGetDataInfo	(	gc::EVENT_HANDLE	eh,
		const void *	buffer,
		size_t	size,
		gc::EVENT_DATA_INFO_CMD	cmd
	)

inline

Retrieves numerical information for an event data given in buffer.

See GenTL::EVENT_DATA_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

T eventGetInfo	(	gc::EVENT_HANDLE	eh,
		gc::EVENT_INFO_CMD	cmd
	)

inline

Retrieves numerical information for an event.

See GenTL::EVENT_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

void eventFlush ( gc::EVENT_HANDLE eh )

inline

Discards all the past occurrences.

void eventKill ( gc::EVENT_HANDLE eh )

inline

Terminates a pending operation.

gc::TL_HANDLE tlOpen ( )

void tlClose ( gc::TL_HANDLE tlh )

T tlGetInfo	(	gc::TL_HANDLE	tlh,
		gc::TL_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the TL module.

See GenTL::TL_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

uint32_t tlGetNumInterfaces ( gc::TL_HANDLE tlh )

inline

std::string tlGetInterfaceID	(	gc::TL_HANDLE	tlh,
		uint32_t	index
	)

inline

T tlGetInterfaceInfo	(	gc::TL_HANDLE	tlh,
		const std::string &	ifID,
		gc::TL_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the Interface module identified by its ID.

See GenTL::INTERFACE_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

gc::IF_HANDLE tlOpenInterface	(	gc::TL_HANDLE	tlh,
		const std::string &	ifID
	)

bool tlUpdateInterfaceList	(	gc::TL_HANDLE	tlh,
		uint64_t	timeout = `GENTL_INFINITE`
	)

inline

Checks whether the list of interface modules has changed.

void ifClose ( gc::IF_HANDLE ifh )

T ifGetInfo	(	gc::IF_HANDLE	ifh,
		gc::INTERFACE_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the Interface module.

See GenTL::INTERFACE_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

uint32_t ifGetNumDevices ( gc::IF_HANDLE ifh )

inline

std::string ifGetDeviceID	(	gc::IF_HANDLE	ifh,
		uint32_t	index
	)

inline

bool ifUpdateDeviceList	(	gc::IF_HANDLE	ifh,
		uint64_t	timeout = `GENTL_INFINITE`
	)

inline

Checks whether the list of devices has changed.

T ifGetDeviceInfo	(	gc::IF_HANDLE	ifh,
		const std::string &	devID,
		gc::INTERFACE_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the Device module identified by its ID.

See GenTL::DEVICE_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

gc::DEV_HANDLE ifOpenDevice	(	gc::IF_HANDLE	ifh,
		const std::string &	devID,
		gc::DEVICE_ACCESS_FLAGS	flags = `defaultDeviceOpenFlags`
	)

gc::PORT_HANDLE devGetPort ( gc::DEV_HANDLE devh )

inline

uint32_t devGetNumDataStreams ( gc::DEV_HANDLE devh )

inline

std::string devGetDataStreamID	(	gc::DEV_HANDLE	devh,
		uint32_t	index
	)

inline

gc::DS_HANDLE devOpenDataStream	(	gc::DEV_HANDLE	devh,
		const std::string &	dsID
	)

void devClose ( gc::DEV_HANDLE devh )

T devGetInfo	(	gc::DEV_HANDLE	devh,
		gc::DEVICE_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the Device module.

See GenTL::DEVICE_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

gc::BUFFER_HANDLE dsAnnounceBuffer	(	gc::DS_HANDLE	dsh,
		void *	buffer,
		size_t	size,
		void *	userPointer = `0`
	)

inline

Gets the handle of a new DataStream buffer allocated by the user.

buffer: user buffer address
size: user buffer size
userPointer: pointer to private data (passed to new buffer events)

gc::BUFFER_HANDLE dsAllocAndAnnounceBuffer	(	gc::DS_HANDLE	dsh,
		size_t	size,
		void *	userPointer = `0`
	)

inline

Gets the handle of a new DataStream buffer allocated automatically.

size: desired buffer size
userPointer: pointer to private data (passed to new buffer events)

gc::BUFFER_HANDLE dsAnnounceBusBuffer	(	gc::DS_HANDLE	dsh,
		uint64_t	busAddress,
		size_t	size,
		void *	userPointer = `0`
	)

inline

Gets the handle of a new DataStream buffer allocated by the user and addressable on the PCIe bus.

buffer: bus buffer address
size: buffer size
userPointer: pointer to private data (passed to new buffer events)

void dsAllocAndAnnounceBuffers	(	gc::DS_HANDLE	dsh,
		size_t	size,
		std::vector< gc::BUFFER_HANDLE > &	buffers
	)

inline

Fills buffers vector with buffers.size handles to newly allocated buffers.

size: desired size for the buffers.

void dsFlushQueue	(	gc::DS_HANDLE	dsh,
		gc::ACQ_QUEUE_TYPE	operation
	)

inline

Flushes a buffers pool/queue.

void dsStartAcquisition	(	gc::DS_HANDLE	dsh,
		gc::ACQ_START_FLAGS	flags = `gc::ACQ_START_FLAGS_DEFAULT`,
		uint64_t	count = `GENTL_INFINITE`
	)

inline

Declares the DataStream ready for acquisition.

does not execute a GenApi StartAcquisition command.

void dsStopAcquisition	(	gc::DS_HANDLE	dsh,
		gc::ACQ_STOP_FLAGS	flags = `gc::ACQ_STOP_FLAGS_DEFAULT`
	)

inline

Declares the DataStream as done with acquisition.

does not execute a GenApi StopAcquisition command.

void dsClose ( gc::DS_HANDLE dsh )

T dsGetInfo	(	gc::DS_HANDLE	dsh,
		gc::STREAM_INFO_CMD	cmd
	)

inline

Retrieves numerical information for the DataStream module.

See GenTL::STREAM_INFO_CMD_LIST for allowed cmd values

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

gc::BUFFER_HANDLE dsGetBufferID	(	gc::DS_HANDLE	dsh,
		uint32_t	index
	)

inline

void dsRevokeBuffer	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh,
		void **	buffer = `0`,
		void **	userPointer = `0`
	)

inline

void dsRevokeBuffers	(	gc::DS_HANDLE	dsh,
		std::vector< gc::BUFFER_HANDLE > &	buffers
	)

inline

Revokes the buffers contained in the buffers vector.

void dsQueueBuffer	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh
	)

inline

Adds a buffer to the input buffer queue.

void dsQueueBuffers	(	gc::DS_HANDLE	dsh,
		const std::vector< gc::BUFFER_HANDLE > &	buffers
	)

inline

Adds the buffers contained in the buffers vector to the input buffer queue.

T dsGetBufferInfo	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh,
		gc::BUFFER_INFO_CMD	cmd
	)

inline

Retrieves numerical information for a buffer.

See GenTL::BUFFER_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

BufferInfo dsGetBufferInfo	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh
	)

inline

Retrieves useful buffer information in one operation.

uint32_t dsGetNumBufferParts	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh
	)

inline

T dsGetBufferPartInfo	(	gc::DS_HANDLE	dsh,
		gc::BUFFER_HANDLE	bh,
		uint32_t	index,
		gc::BUFFER_PART_INFO_CMD	cmd
	)

inline

Retrieves numerical information for a buffer part.

See GenTL::BUFFER_PART_INFO_CMD_LIST for allowed cmd values.

Exceptions

unexpected_data_type if the size of the argument type T does not match the actual size.

uint32_t gcGetNumPortURLs ( gc::PORT_HANDLE h )

inline

T gcGetPortURLInfo	(	gc::PORT_HANDLE	h,
		uint32_t	index,
		gc::URL_INFO_CMD	cmd
	)

inline

void gcReadPortStacked	(	gc::PORT_HANDLE	h,
		std::vector< gc::PORT_REGISTER_STACK_ENTRY > &	entries
	)

inline

Reads a number of bytes from the given address on the specified port for every element in the entries vector.

Note: If an exception occurs, entries is resized according to the number of successful operations.

void gcWritePortStacked	(	gc::PORT_HANDLE	h,
		std::vector< gc::PORT_REGISTER_STACK_ENTRY > &	entries
	)

inline

Writes a number of bytes to the given address on the specified port for every element in the entries vector.

Note: If an exception occurs, entries is resized according to the number of successful operations.

gc::TL_HANDLE ifGetParent ( gc::IF_HANDLE ifh )

inline

gc::IF_HANDLE devGetParent ( gc::DEV_HANDLE devh )

inline

gc::DEV_HANDLE dsGetParent ( gc::DS_HANDLE dsh )

inline

void memento ( const std::string & text )

inline

Reports a string to the memento logging system.

void memento	(	unsigned char	verbosity,
		unsigned char	kind,
		const std::string &	text
	)

inline

void genapiSetString	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		const std::string &	value
	)

inline

Updates a feature with string contents.

See also: Euresys::action

Exceptions

gentl_error if feature is missing or read-only.

std::string genapiGetString	(	gc::PORT_HANDLE	h,
		const std::string &	feature
	)

inline

Reads a feature as string.

Exceptions

gentl_error if feature is missing.

Note: when an integer or a float feature is accessed, optional suffixes (as documented in genapiGetInteger and genapiGetFloat) can be used

See also: Euresys::query

void genapiGetStringData	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		std::vector< char > &	data
	)

inline

Reads a feature into a vector, the size of the vector is updated.

Exceptions

gentl_error if feature is missing.

Note: if the vector is not empty, the read operation is tried on the available vector buffer; if the buffer is too small, the data size is queried and the vector size is updated accordingly before retrying the read operation; when an integer or a float feature is accessed, optional suffixes (as documented in genapiGetInteger and genapiGetFloat) can be used

See also: Euresys::query

std::vector<std::string> genapiGetStringList	(	gc::PORT_HANDLE	h,
		const std::string &	what
	)

inline

Reads a list of strings.

Exceptions

gentl_error if an error occurs.

See also: Euresys::query

void genapiSetInteger	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		int64_t	value
	)

inline

Updates a feature with integer value.

Exceptions

gentl_error if feature is missing or read-only.

int64_t genapiGetInteger	(	gc::PORT_HANDLE	h,
		const std::string &	feature
	)

inline

Reads a feature as an integer.

Parameters

h	port handle
feature	name of feature to read with or without one of the following suffixes: .Min: to read the minimum of the feature .Max: to read the maximum of the feature .Inc: to read the increment of the feature .Value: to read the value of the feature (same as without .Value suffix)

Exceptions

gentl_error if feature is missing.

Examples:

genapiGetInteger(cameraHandle, "Width");
genapiGetInteger(deviceHandle, "CxpTriggerMaxResendCount.Max");

int64_t genapiGetIntegerWithDefault	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		int64_t	defaultValue
	)

inline

Reads a feature as an integer.

Returns: feature value or defaultValue if feature is missing.

void genapiSetFloat	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		double	value
	)

inline

Updates a feature with float value.

Exceptions

gentl_error if feature is missing or read-only.

double genapiGetFloat	(	gc::PORT_HANDLE	h,
		const std::string &	feature
	)

inline

Reads a feature as a float.

Parameters

h	port handle
feature	name of feature to read with or without one of the following suffixes: .Min: to read the minimum of the feature .Max: to read the maximum of the feature .Inc: to read the increment of the feature (when defined) .Value: to read the value of the feature (same as without .Value suffix)

Exceptions

gentl_error if feature is missing.

Examples:

genapiGetFloat(interfaceHandle, "Temperature");
genapiGetFloat(deviceHandle, "CycleMinimumPeriod.Min");

double genapiGetFloatWithDefault	(	gc::PORT_HANDLE	h,
		const std::string &	feature,
		double	defaultValue
	)

inline

Reads a feature as a float.

Returns: feature value or default_value if feature is missing.

void genapiExecuteCommand	(	gc::PORT_HANDLE	h,
		const std::string &	feature
	)

inline

Executes a GenApi command.

void genapiAttachEvent	(	gc::PORT_HANDLE	h,
		uint64_t	eventId,
		const void *	buffer,
		size_t	size
	)

inline

Attach a GenApi event.

void genapiRunScript	(	gc::PORT_HANDLE	h,
		const std::string &	script,
		ge::GENAPI_UI_SCRIPT_CONTEXT *	context = `0`
	)

inline

Run a Euresys GenApi script.

void genapiRunScript	(	const std::vector< gc::PORT_HANDLE > &	handles,
		const std::string &	script,
		ge::GENAPI_UI_SCRIPT_CONTEXT *	context = `0`
	)

inline

Run a Euresys GenApi script.

void genapiInterruptScript ( const std::string & scriptId )

inline

Interrupt a running Euresys GenApi script.

Precondition: genapiInterruptScript cannot be called from the GenTL::EuresysCustomGenTL::GENAPI_UI_SCRIPT_CONTEXT callback

unsigned int imageGetPixelFormatValue	(	const std::string &	format,
		unsigned int	ns
	)

inline

Get PFNC value from name.

std::string imageGetPixelFormat ( uint64_t format )

inline

unsigned int imageGetBytesPerPixel ( const std::string & format )

inline

Get Bytes per pixel.

unsigned int imageGetBitsPerPixel ( const std::string & format )

inline

Get Bits per pixel.

void imageConvert	(	const ge::ImageConvertInput &	input,
		const ge::ImageConvertOutput &	output,
		const ge::ImageConvertROI *	roi
	)

inline

Convert an image.

void imageSaveToDisk	(	const ge::ImageConvertInput &	input,
		const std::string &	filepath,
		int64_t	index = `-1`,
		const ge::ImageSaveToDiskParams *	params = `0`
	)

inline

Save an image to disk.

void* imageGet	(	ge::ImageId	id,
		size_t *	outSize = `0`
	)

inline

Get information of an image.

void imageRelease ( ge::ImageId id )

inline

Release an image.

bool isShared ( ) const

inline

void eventKillQuiet ( gc::EVENT_HANDLE eh )

inline

void lockUpdates ( )

inline

void unlockUpdates ( )

inline

Member Data Documentation

ETraceContext& traceCtx

The documentation for this class was generated from the following file:

EGenTL.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation