rcg Namespace Reference

Classes
class	Buffer
class	CPort
class	Device
class	GenTLException
class	GenTLWrapper
class	Image
class	ImageList
class	Interface
class	Stream
class	System
Enumerations
enum	PAYLOADTYPE_INFO_IDS {   PAYLOAD_TYPE_UNKNOWN = 0, PAYLOAD_TYPE_IMAGE = 1, PAYLOAD_TYPE_RAW_DATA = 2, PAYLOAD_TYPE_FILE = 3,   PAYLOAD_TYPE_CHUNK_DATA = 4, PAYLOAD_TYPE_JPEG = 5, PAYLOAD_TYPE_JPEG2000 = 6, PAYLOAD_TYPE_H264 = 7,   PAYLOAD_TYPE_CHUNK_ONLY = 8, PAYLOAD_TYPE_DEVICE_SPECIFIC = 9, PAYLOAD_TYPE_MULTI_PART = 10, PAYLOAD_TYPE_CUSTOM_ID = 1000 }
enum	PIXELFORMAT_NAMESPACE_IDS {   PIXELFORMAT_NAMESPACE_UNKNOWN = 0, PIXELFORMAT_NAMESPACE_GEV = 1, PIXELFORMAT_NAMESPACE_IIDC = 2, PIXELFORMAT_NAMESPACE_PFNC_16BIT = 3,   PIXELFORMAT_NAMESPACE_PFNC_32BIT = 4, PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000 }
Functions
std::shared_ptr < GenApi::CNodeMapRef >	allocNodeMap (std::shared_ptr< const GenTLWrapper > gentl, void *port, CPort *cport, const char *xml)
void	checkFeature (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, const char *value)
void	convYCbCr411toQuadRGB (uint8_t rgb[12], const uint8_t *row, int i)
void	convYCbCr411toRGB (uint8_t rgb[3], const uint8_t *row, int i)
std::vector< std::string >	getAvailableGenTLs (const char *paths)
bool	getBoolean (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception)
void	getColor (uint8_t rgb[3], const std::shared_ptr< const rcg::Image > &img, uint32_t ds, uint32_t i, uint32_t k)
std::shared_ptr< Device >	getDevice (const char *id)
std::vector< std::shared_ptr < Device > >	getDevices ()
std::string	getEnum (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception)
std::string	getEnum (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, std::vector< std::string > &list, bool exception)
double	getFloat (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, double *vmin, double *vmax, bool exception)
int64_t	getInteger (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, int64_t *vmin, int64_t *vmax, bool exception)
std::string	getString (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception)
bool	isHostBigEndian ()
bool	setBoolean (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool value, bool exception)
bool	setEnum (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, const char *value, bool exception)
bool	setFloat (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, double value, bool exception)
bool	setInteger (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, int64_t value, bool exception)
bool	setIPV4Address (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, const char *value, bool exception)
bool	setString (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, const char *value, bool exception)

---

Enumeration Type Documentation

enum rcg::PAYLOADTYPE_INFO_IDS

Payload types as taken from GenTL 1.5 definition. See Buffer::getPayloadType().

Enumerator:

PAYLOAD_TYPE_UNKNOWN
PAYLOAD_TYPE_IMAGE
PAYLOAD_TYPE_RAW_DATA
PAYLOAD_TYPE_FILE
PAYLOAD_TYPE_CHUNK_DATA
PAYLOAD_TYPE_JPEG
PAYLOAD_TYPE_JPEG2000
PAYLOAD_TYPE_H264
PAYLOAD_TYPE_CHUNK_ONLY
PAYLOAD_TYPE_DEVICE_SPECIFIC
PAYLOAD_TYPE_MULTI_PART
PAYLOAD_TYPE_CUSTOM_ID

Definition at line 52 of file buffer.h.

enum rcg::PIXELFORMAT_NAMESPACE_IDS

Pixelformat namespace IDs as taken from GenTL 1.5 definition. See Buffer::getPixelFormatNamespace().

Enumerator:

PIXELFORMAT_NAMESPACE_UNKNOWN
PIXELFORMAT_NAMESPACE_GEV
PIXELFORMAT_NAMESPACE_IIDC
PIXELFORMAT_NAMESPACE_PFNC_16BIT
PIXELFORMAT_NAMESPACE_PFNC_32BIT
PIXELFORMAT_NAMESPACE_CUSTOM_ID

Definition at line 74 of file buffer.h.

---

Function Documentation

std::shared_ptr< GenApi::CNodeMapRef > rcg::allocNodeMap	(	std::shared_ptr< const GenTLWrapper >	gentl,
		void *	port,
		CPort *	cport,
		const char *	xml = 0
	)

Convenience function that returns a GenICam node map from the given port.

Parameters:

gentl	Pointer to GenTL Wrapper.
port	Pointer to module or remote port.
cport	Pointer to CPort Wrapper.
xml	Path and name for storing the received XML file or 0 if xml file should not be stored.

Returns:

Allocated node map object or 0 if it cannot be allocated. The pointer must be freed by the calling function with delete.

Definition at line 122 of file cport.cc.

void rcg::checkFeature	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		const char *	value
	)

Definition at line 783 of file config.cc.

void rcg::convYCbCr411toQuadRGB	(	uint8_t	rgb[12],
		const uint8_t *	row,
		int	i
	)

Conversion of a group of four pixels from YCbCr411 format (6 bytes for four pixels) to RGB. Conversion of four pixels is a bit more efficient than conversions of individual pixels.

Parameters:

rgb	Pointer to an array of size 3 for storing the result.
row	Image row.
i	Index of first pixel in row that should be converted. The index must be a multiple of 4!

Definition at line 113 of file image.cc.

void rcg::convYCbCr411toRGB	(	uint8_t	rgb[3],
		const uint8_t *	row,
		int	i
	)

Conversion of one pixel from YCbCr411 format (6 bytes for four pixels) to RGB.

Parameters:

rgb	Pointer to an array of size 3 for storing the result.
row	Image row.
i	Index of pixel in row that should be converted.

Definition at line 90 of file image.cc.

std::vector< std::string > rcg::getAvailableGenTLs

(

const char *

paths

)

The function uses the given list files of paths that is separated by colons or semicolons, depending on the used operating system, and returns all files with the suffix .cti.

Parameters:

Paths,which

may be 0.

Returns:

List of files with suffix cti, including path to that file.

Definition at line 50 of file gentl_wrapper_linux.cc.

bool rcg::getBoolean	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		bool	exception = false
	)

Get the value of a boolean feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
exception	True if an error should be signaled via exception.

Returns:

Value of boolean feature or false if the feature does not exist, has a different datatype or is not readable.

Definition at line 431 of file config.cc.

void rcg::getColor	(	uint8_t	rgb[3],
		const std::shared_ptr< const rcg::Image > &	img,
		uint32_t	ds,
		uint32_t	i,
		uint32_t	k
	)

Expects an image in Mono8 or YCbCr411_8 format and returns the color as RGB value at the given pixel location. The downscale factor ds can be greater than one. In this case, the given pixel location refers to the downscaled image and the returned color is averaged over ds x ds pixels.

Parameters:

rgb	Array of size 3 for returning the color.
img	Pointer to image.
ds	Downscale factor, i.e. >= 1
i,k	Pixel location in downscaled coordinates.

Definition at line 133 of file image.cc.

std::shared_ptr< Device > rcg::getDevice

(

const char *

devid

)

Searches across all transport layers and interfaces for a device. This method accepts optionally specifying the interface ID as prefix, followed by ':', i.e. "[<interfaca_id>[:]]<device_id>". If the interface ID is not given, then all interfaces are sought and the first device with the given ID returned.

Parameters:

devid

Device ID.

Returns:

Device or null pointer.

Definition at line 434 of file device.cc.

std::vector< std::shared_ptr< Device > > rcg::getDevices

(

)

Returns a list of all devices that are available across all transport layers and interfaces.

Returns:

List of available devices.

Definition at line 402 of file device.cc.

std::string rcg::getEnum	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		bool	exception = false
	)

Get the value of an enumeration of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
exception	True if an error should be signaled via exception.

Returns:

Value of enumeration or an empty string if the feature does not exist, has a different datatype or is not readable.

Definition at line 578 of file config.cc.

std::string rcg::getEnum	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		std::vector< std::string > &	list,
		bool	exception = false
	)

Get the current value and list of possible values of an enumeration of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
list	List of possible values.
exception	True if an error should be signaled via exception.

Returns:

Value of enumeration or an empty string if the feature does not exist, has a different datatype or is not readable. In this case, the returned list will be empty.

Definition at line 623 of file config.cc.

double rcg::getFloat	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		double *	vmin = 0,
		double *	vmax = 0,
		bool	exception = false
	)

Get the value of a double feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
vmin	Minimum value. A null poiter can be given if the value is not required.
vmax	Maximum value. A null poiter can be given if the value is not required.
exception	True if an error should be signaled via exception.

Returns:

Value of feature or 0 if the feature does not exist, has a different datatype or is not readable. In this case vmin and vmax will also be set to 0.

Definition at line 527 of file config.cc.

int64_t rcg::getInteger	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		int64_t *	vmin = 0,
		int64_t *	vmax = 0,
		bool	exception = false
	)

Get the value of an integer feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
vmin	Minimum value. A null poiter can be given if the value is not required.
vmax	Maximum value. A null poiter can be given if the value is not required.
exception	True if an error should be signaled via exception.

Returns:

Value of feature or 0 if the feature does not exist, has a different datatype or is not readable. In this case vmin and vmax will also be set to 0.

Definition at line 476 of file config.cc.

std::string rcg::getString	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		bool	exception = false
	)

Get the value of a feature of the given nodemap. The datatype of the feature can be boolean, integer, float, enum or string. The given value will be converted depending on the datatype and representation of the feature, which can be hex, ip4v or mac for an integer feature.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
exception	True if an error should be signaled via exception.

Returns:

Value or an empty string if the feature does not exist, has a different datatype or is not readable.

Definition at line 678 of file config.cc.

bool rcg::isHostBigEndian

(

)

Definition at line 332 of file buffer.cc.

bool rcg::setBoolean	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		bool	value,
		bool	exception = false
	)

Set the value of a boolean feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	New value of feature.
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist, has a different datatype or is not writable.

Definition at line 46 of file config.cc.

bool rcg::setEnum	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		const char *	value,
		bool	exception = false
	)

Set the value of an enumeration of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	New value of feature.
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist, has a different datatype or is not writable.

Definition at line 241 of file config.cc.

bool rcg::setFloat	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		double	value,
		bool	exception = false
	)

Set the value of a float feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	New value of feature.
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist, has a different datatype or is not writable.

Definition at line 195 of file config.cc.

bool rcg::setInteger	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		int64_t	value,
		bool	exception = false
	)

Set the value of an integer feature of the given nodemap.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	New value of feature.
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist, has a different datatype or is not writable.

Definition at line 92 of file config.cc.

bool rcg::setIPV4Address	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		const char *	value,
		bool	exception
	)

Set the value of an integer feature of the given nodemap from an IP address.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	IP address formated as string, i.e. <v0>.<v1>.<v2>.<v3>
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist, has a different datatype or is not writable.

Definition at line 138 of file config.cc.

bool rcg::setString	(	const std::shared_ptr< GenApi::CNodeMapRef > &	nodemap,
		const char *	name,
		const char *	value,
		bool	exception = false
	)

Set the value of a feature of the given nodemap. The datatype of the feature can be boolean, integer, float, enum or string. The given value will be converted depending on the datatype and representation of the feature, which can be hex, ip4v or mac for an integer feature.

Parameters:

nodemap	Initialized nodemap.
name	Name of feature.
value	New value of feature.
exception	True if an error should be signaled via exception instead of a return value.

Returns:

True if value has been changed. False if feature does not exist or is not writable or conversion failed.

Definition at line 298 of file config.cc.