Zebra Bioptic Color Camera SDK For Linux  1.0.0-17
•All Classes Functions Variables Enumerations Enumerator
Classes | Public Member Functions | Public Attributes | List of all members
zebra::camera_sdk::CameraConfiguration Class Reference

#include <camera_configuration.h>

Classes

struct  AttributeInfo
 

Public Member Functions

void GenerateXmlConfiguration (pugi::xml_document *config_doc, std::shared_ptr< ZebraCamera > camera)
 
void AppendMetadataNode (pugi::xml_node *node, std::shared_ptr< ZebraCamera > camera)
 
void AppendAttributeNode (pugi::xml_node *node, zebra::camera_sdk::CameraPropertyId attribute_id, std::shared_ptr< ZebraCamera > camera)
 
void SetParameter (std::shared_ptr< ZebraCamera > camera, pugi::xml_node attribute_node)
 
bool ValidateConfigurationFileExtension (std::string configuration_file_path)
 

Public Attributes

const std::string kXmlSchema = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
 
const std::string kTagNameConfig = "cameraconfig"
 
const std::string kVersion = "version"
 
const std::string kAppVersion = "app-version"
 
const std::string kMetadata = "metadata"
 
const std::string kFirmware = "firmware"
 
const std::string kSerialNumber = "serialnumber"
 
const std::string kModelNumber = "modelnumber"
 
const std::string kHardwareVersion = "hardwareversion"
 
const std::string kAttribList = "attrib_list"
 
const std::string kAttribute = "attribute"
 
const std::string kAuto = "auto"
 
const std::string kStrAutoSupported = "auto_supported"
 
const std::string kStrOne = "1"
 
const std::string kStrZero = "0"
 
const std::string kStrTrue = "true"
 
const std::string kStrFalse = "false"
 
const std::string kStrConfig = "cameraconfig"
 
const std::string kStrAttriblist = "attrib_list"
 
const std::string kStrAttribute = "attribute"
 
const std::string kStrId = "id"
 
const std::string kStrName = "name"
 
const std::string kStrValue = "value"
 
const std::string kStrRed = "red"
 
const std::string kStrBlue = "blue"
 
const std::string kParameterNameBrighness = "Brightness"
 
const std::string kParameterNameGamma = "Gamma"
 
const std::string kParameterNameContrast = "Contrast"
 
const std::string kParameterNameSaturation = "Saturation"
 
const std::string kParameterNameSharpness = "Sharpness"
 
const std::string kParameterNameWhiteBalance = "White Balance"
 
const std::string kParameterNameWhiteBalanceBlue = "White Balance - Blue"
 
const std::string kParameterNameWhiteBalanceRed = "White Balance - Red"
 
const std::string kParameterNameBacklight = "Backlight"
 
const std::string kParameterNameGain = "Gain"
 
const std::string kParameterNameAbsoluteET = "Absolute Exposure Time"
 
const std::string kParameterNameVideoMode = "Video Mode"
 
const std::string kParameterNameIlluminationMode = "Illumination Mode"
 

Detailed Description

Get attribute values using color camera object and generate the attribute elements for the configuration file.

Member Function Documentation

◆ AppendAttributeNode()

void zebra::camera_sdk::CameraConfiguration::AppendAttributeNode ( pugi::xml_node *  node,
zebra::camera_sdk::CameraPropertyId  attribute_id,
std::shared_ptr< ZebraCamera >  camera 
)

@breef Append attribute node as a attribute child element

Parameters
node- pugi::xml_node to append child metadata node
attribute_id- attribute ID
camera- zebra camera object to get properties

◆ AppendMetadataNode()

void zebra::camera_sdk::CameraConfiguration::AppendMetadataNode ( pugi::xml_node *  node,
std::shared_ptr< ZebraCamera >  camera 
)

@breef Append metadata of color camera for configuration

Parameters
node- pugi::xml_node to append child metadata node
camera- zebra camera object to get properties

◆ GenerateXmlConfiguration()

void zebra::camera_sdk::CameraConfiguration::GenerateXmlConfiguration ( pugi::xml_document *  config_doc,
std::shared_ptr< ZebraCamera >  camera 
)

Generate xml configuration pugi xml document object

Parameters
config_doc- pugi::xml_document for configuration out put
camera- zebra camera object to get properties

◆ SetParameter()

void zebra::camera_sdk::CameraConfiguration::SetParameter ( std::shared_ptr< ZebraCamera >  camera,
pugi::xml_node  attribute_node 
)

@breef set color camera parameter

Parameters
cameraintended camera object
attribute_nodeXML tag node for the attribute

◆ ValidateConfigurationFileExtension()

bool zebra::camera_sdk::CameraConfiguration::ValidateConfigurationFileExtension ( std::string  configuration_file_path)

@breef Validates the configuration file extension

Parameters
coniguration_file_pathpath of the .camcfg file
Returns
true for valid, false otherwise.
The documentation for this class was generated from the following file: