Classes | Enumerations | Functions
rcg Namespace Reference

Classes

class  Buffer
 The buffer class encapsulates a Genicam buffer that is provided by a stream. More...
 
class  CPort
 This is the port definition that connects GenAPI to GenTL. More...
 
class  Device
 The device class encapsulates a Genicam device. More...
 
class  GenTLException
 
class  GenTLWrapper
 Wrapper for dynamically loaded GenICam transport layers. More...
 
class  Image
 The image class encapsulates image information. More...
 
class  ImageList
 An object of this class manages a limited number of images. More...
 
class  Interface
 The interface class encapsulates a Genicam interface. More...
 
class  Stream
 The stream class encapsulates a Genicam stream. More...
 
class  System
 The system class encapsulates a Genicam transport layer. More...
 

Enumerations

enum  PARTDATATYPE_IDS {
  PART_DATATYPE_UNKNOWN = 0, PART_DATATYPE_2D_IMAGE = 1, PART_DATATYPE_2D_PLANE_BIPLANAR = 2, PART_DATATYPE_2D_PLANE_TRIPLANAR = 3,
  PART_DATATYPE_2D_PLANE_QUADPLANAR = 4, PART_DATATYPE_3D_IMAGE = 5, PART_DATATYPE_3D_PLANE_BIPLANAR = 6, PART_DATATYPE_3D_PLANE_TRIPLANAR = 7,
  PART_DATATYPE_3D_PLANE_QUADPLANAR = 8, PART_DATATYPE_CONFIDENCE_MAP = 9, PART_DATATYPE_CHUNKDATA = 10, PART_DATATYPE_CUSTOM_ID = 1000
}
 Enumeration describing which data type is present in given buffer part as taken from GenTL 1.5 definition. More...
 
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
}
 Payload types as taken from GenTL 1.5 definition. More...
 
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
}
 Pixelformat namespace IDs as taken from GenTL 1.5 definition. More...
 

Functions

std::shared_ptr< GenApi::CNodeMapRefallocNodeMap (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. More...
 
bool callCommand (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception=false)
 Calls the given command. More...
 
void checkFeature (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, const char *value, bool igncache=false)
 Checks the value of given feature and throws an exception in case of a mismatch. More...
 
void 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. More...
 
void 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. More...
 
std::vector< std::string > 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. More...
 
bool getBoolean (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception=false, bool igncache=false)
 Get the value of a boolean feature of the given nodemap. More...
 
std::shared_ptr< GenApi::CChunkAdaptergetChunkAdapter (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const std::string &tltype)
 Sets ChunkModeActive to 1, creates a chunk adapter for the specified transport layer and attaches it to the given nodemap. More...
 
void 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. More...
 
std::string getComponetOfPart (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const rcg::Buffer *buffer, uint32_t ipart)
 
std::shared_ptr< DevicegetDevice (const char *devid)
 Searches across all transport layers and interfaces for a device. More...
 
std::vector< std::shared_ptr< Device > > getDevices ()
 Returns a list of all devices that are available across all transport layers and interfaces. More...
 
std::string getEnum (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception=false)
 Get the value of an enumeration of the given nodemap. More...
 
std::string 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. More...
 
double getFloat (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, double *vmin=0, double *vmax=0, bool exception=false, bool igncache=false)
 Get the value of a double feature of the given nodemap. More...
 
int64_t getInteger (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, int64_t *vmin=0, int64_t *vmax=0, bool exception=false, bool igncache=false)
 Get the value of an integer feature of the given nodemap. More...
 
std::string getString (const std::shared_ptr< GenApi::CNodeMapRef > &nodemap, const char *name, bool exception=false, bool igncache=false)
 Get the value of a feature of the given nodemap. More...
 
bool isHostBigEndian ()
 
bool 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. More...
 
bool 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. More...
 
bool 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. More...
 
bool 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. More...
 
bool 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. More...
 
bool 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. More...
 

Enumeration Type Documentation

Enumeration describing which data type is present in given buffer part as taken from GenTL 1.5 definition.

See Buffer::getPartDataType().

Enumerator
PART_DATATYPE_UNKNOWN 
PART_DATATYPE_2D_IMAGE 
PART_DATATYPE_2D_PLANE_BIPLANAR 
PART_DATATYPE_2D_PLANE_TRIPLANAR 
PART_DATATYPE_2D_PLANE_QUADPLANAR 
PART_DATATYPE_3D_IMAGE 
PART_DATATYPE_3D_PLANE_BIPLANAR 
PART_DATATYPE_3D_PLANE_TRIPLANAR 
PART_DATATYPE_3D_PLANE_QUADPLANAR 
PART_DATATYPE_CONFIDENCE_MAP 
PART_DATATYPE_CHUNKDATA 
PART_DATATYPE_CUSTOM_ID 

Definition at line 91 of file buffer.h.

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 53 of file buffer.h.

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 75 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
gentlPointer to GenTL Wrapper.
portPointer to module or remote port.
cportPointer to CPort Wrapper.
xmlPath 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 133 of file cport.cc.

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

Calls the given command.

Parameters
nodemapInitialized nodemap.
nameName of command.
exceptionTrue 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 53 of file config.cc.

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

Checks the value of given feature and throws an exception in case of a mismatch.

The check succeeds if the feature does not exist.

Parameters
nodemapFeature nodemap.
nameName of feature.
valueExpected value of feature.
igncacheTrue if value is always read from the device, even if cached.

Definition at line 858 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
rgbPointer to an array of size 3 for storing the result.
rowImage row.
iIndex of first pixel in row that should be converted. The index must be a multiple of 4!

Definition at line 112 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
rgbPointer to an array of size 3 for storing the result.
rowImage row.
iIndex of pixel in row that should be converted.

Definition at line 89 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,whichmay 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,
bool  igncache = false 
)

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

Parameters
nodemapInitialized nodemap.
nameName of feature.
exceptionTrue if an error should be signaled via exception.
igncacheTrue if value is always read from the device, even if cached.
Returns
Value of boolean feature or false if the feature does not exist, has a different datatype or is not readable.

Definition at line 497 of file config.cc.

std::shared_ptr< GenApi::CChunkAdapter > rcg::getChunkAdapter ( const std::shared_ptr< GenApi::CNodeMapRef > &  nodemap,
const std::string &  tltype 
)

Sets ChunkModeActive to 1, creates a chunk adapter for the specified transport layer and attaches it to the given nodemap.

The returned chunk adapter must be attached to a buffer that contains chunk data. Thereafter, the data can be accessed through the Chunk* features of the given nodemap. After accessing all required data, the adapter must be detached from the buffer!

Parameters
nodemapFeature nodemap.
tltypeTransport layer type as returned by, e.g. System::getTLType() or Device::getTLType()
Returns
Chunk adapter that is already attached to the given nodemap or null pointer if chunk mode cannot be activated.

Definition at line 871 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
rgbArray of size 3 for returning the color.
imgPointer to image.
dsDownscale factor, i.e. >= 1
i,kPixel location in downscaled coordinates.

Definition at line 132 of file image.cc.

std::string rcg::getComponetOfPart ( const std::shared_ptr< GenApi::CNodeMapRef > &  nodemap,
const rcg::Buffer buffer,
uint32_t  ipart 
)

Definition at line 895 of file config.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
devidDevice ID.
Returns
Device or null pointer.

Definition at line 469 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 437 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
nodemapInitialized nodemap.
nameName of feature.
exceptionTrue 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 644 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
nodemapInitialized nodemap.
nameName of feature.
listList of possible values.
exceptionTrue 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 698 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,
bool  igncache = false 
)

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

Parameters
nodemapInitialized nodemap.
nameName of feature.
vminMinimum value. A null poiter can be given if the value is not required.
vmaxMaximum value. A null poiter can be given if the value is not required.
exceptionTrue if an error should be signaled via exception.
igncacheTrue if value is always read from the device, even if cached.
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 593 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,
bool  igncache = false 
)

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

Parameters
nodemapInitialized nodemap.
nameName of feature.
vminMinimum value. A null poiter can be given if the value is not required.
vmaxMaximum value. A null poiter can be given if the value is not required.
exceptionTrue if an error should be signaled via exception.
igncacheTrue if value is always read from the device, even if cached.
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 542 of file config.cc.

std::string rcg::getString ( const std::shared_ptr< GenApi::CNodeMapRef > &  nodemap,
const char *  name,
bool  exception = false,
bool  igncache = 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
nodemapInitialized nodemap.
nameName of feature.
exceptionTrue if an error should be signaled via exception.
igncacheTrue if value is always read from the device, even if cached.
Returns
Value or an empty string if the feature does not exist, has a different datatype or is not readable.

Definition at line 753 of file config.cc.

bool rcg::isHostBigEndian ( )

Definition at line 536 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
nodemapInitialized nodemap.
nameName of feature.
valueNew value of feature.
exceptionTrue 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 99 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
nodemapInitialized nodemap.
nameName of feature.
valueNew value of feature.
exceptionTrue 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 294 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
nodemapInitialized nodemap.
nameName of feature.
valueNew value of feature.
exceptionTrue 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 248 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
nodemapInitialized nodemap.
nameName of feature.
valueNew value of feature.
exceptionTrue 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 145 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
nodemapInitialized nodemap.
nameName of feature.
valueIP address formated as string, i.e. <v0>.<v1>.<v2>.<v3>
exceptionTrue 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 191 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
nodemapInitialized nodemap.
nameName of feature.
valueNew value of feature.
exceptionTrue 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 351 of file config.cc.



rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:56