This is a helper class for Pylon camera settings. More...

#include <PylonCameraOptions.h>

Inheritance diagram for icl::io::pylon::PylonCameraOptions:

Public Member Functions
	PylonCameraOptions (Pylon::IPylonDevice camera, Interruptable interu)
	Constructor. More...

	~PylonCameraOptions ()
	Destructor. More...

Pylon::PixelType	getCameraPixelType ()
	convenience function to get the cameras PixelType More...

int	getCameraPixelSize ()
	getter for cameras PixelSize in bits More...

long	getNeededBufferSize ()
	getter of the BufferSize needed by the camera. More...

void	acquisitionStart ()
	Executes the ICommand 'AcquisitionStart'. More...

void	acquisitionStop ()
	Executes the ICommand 'AcquisitionStop'. More...

int	getHeight ()
	getter for the camera image height. More...

int	getWidth ()
	getter for the camera image width. More...

std::string	getFormatString ()
	returns the cameras PixelFormat as string More...

bool	omitDoubleFrames ()
	whether double frames should be omitted. More...

double	getResultingFrameRateAbs ()
	getter for the current expected framerate More...

Public Member Functions inherited from icl::utils::Configurable
virtual	~Configurable ()
	virtual destructor More...

	Configurable (const Configurable &other)
	Copy constructor. More...

Configurable &	operator= (const Configurable &other)
	Assignment operator. More...

void	setConfigurableID (const std::string &ID)
	sets the ID of this configurable More...

const std::string &	getConfigurableID () const
	returns the configurables static ID More...

bool	isOrderedFlagSet () const
	returns whether the ordered flag is set More...

void	deactivateProperty (const std::string &pattern)
	adds an additional deativation pattern More...

void	deleteDeactivationPattern (const std::string &pattern)
	removed a formerly added deactivation pattern More...

std::vector< std::string >	getPropertyListWithoutDeactivated () const
	this returns a filtered list of properties (using all filters added by deactivateProperty) More...

virtual void	adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip)
	this function can be used to adapt a specific property afterwards More...

void	registerCallback (const Callback &cb)
	add a callback for changed properties More...

void	removedCallback (const Callback &cb)
	removes a callback that was registered before More...

void	syncChangesTo (Configurable *others, int num=1)
	this can be used to let this instance also apply property changes to others More...

virtual void	setPropertyValue (const std::string &propertyName, const Any &value)
	sets a property value More...

virtual std::vector< std::string >	getPropertyList () const
	returns a list of All properties, that can be set using setProperty More...

virtual bool	supportsProperty (const std::string &propertyName) const
	base implementation for property check (seaches in the property list) More...

virtual void	saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
	writes all available properties into a file More...

virtual void	loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
	reads a camera config file from disc More...

virtual std::string	getPropertyType (const std::string &propertyName) const
	get type of property More...

virtual std::string	getPropertyInfo (const std::string &propertyName) const
	get information of a properties valid values More...

virtual Any	getPropertyValue (const std::string &propertyName) const
	returns the current value of a property or a parameter More...

virtual std::string	getPropertyToolTip (const std::string &propertyName) const
	returns the tooltip description for a given property More...

virtual int	getPropertyVolatileness (const std::string &propertyName) const
	Returns whether this property may be changed internally. More...

Private Member Functions
std::string	getType (const std::string &name)
	get type of property. More...

std::string	getInfo (const std::string &name)
	get information of a properties valid values. More...

std::string	getValue (const std::string &name)
	returns the current value of a property or a parameter. More...

int	isVolatile (const std::string &propertyName)
	Returns whether this property may be changed internally. More...

void	processPropertyChange (const utils::Configurable::Property &prop)
	callback for changed configurable properties More...

void	addToPropertyList (std::vector< std::string > &ps, const GenApi::CNodePtr &node)
	helper function for getPropertyList. More...

GenApi::INode *	getNode (std::string name)
	gets the corresponding CValuePtr to the passed name. More...

Private Attributes
Interruptable *	m_Interu
	the Interruptable that provides interruption for the camera. More...

Pylon::IPylonDevice *	m_Camera
	The camera. More...

bool	m_OmitDoubleFrames
	whether double frames should be omitted. More...

Additional Inherited Members
Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & >	Callback
	Function type for changed properties. More...

Static Public Member Functions inherited from icl::utils::Configurable
static std::string	create_default_ID (const std::string &prefix)
	this function can be used in subclasses to create a default ID More...

static Configurable *	get (const std::string &id)
	returns configurable by given ID More...

static void	register_configurable_type (const std::string &classname, Function< Configurable * > creator)
	registers a configurable type More...

static std::vector< std::string >	get_registered_configurables ()
	returns a list of all registered configurable classnames More...

static Configurable *	create_configurable (const std::string &classname)
	creates a configurable by given name More...

Static Public Attributes inherited from icl::utils::Configurable
static const std::vector< std::string >	EMPTY_VEC
	used as shortcut – just an empty vector of std::strings More...

Protected Member Functions inherited from icl::utils::Configurable
void	addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string())
	This can be used by derived classes to store supported properties in the internal list. More...

void	addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
	This adds another configurable as child. More...

void	removeChildConfigurable (Configurable *configurable)
	removes the given child configurable More...

Property &	prop (const std::string &propertyName)
	this CAN be used e.g. to store a property value in internal property-list More...

const Property &	prop (const std::string &propertyName) const
	this CAN be used e.g. to store a property value in internal property-list More...

	Configurable (const std::string &ID="", bool ordered=true)
	create this configurable with given ID More...

void	call_callbacks (const std::string &propertyName, const Configurable *caller) const
	calls all registered callbacks More...

Protected Attributes inherited from icl::utils::Configurable
std::vector< Callback >	callbacks
	internally managed list of callbacks More...

Detailed Description

This is a helper class for Pylon camera settings.

Constructor & Destructor Documentation

◆ PylonCameraOptions()

icl::io::pylon::PylonCameraOptions::PylonCameraOptions	(	Pylon::IPylonDevice *	camera,
		Interruptable *	interu
	)

Constructor.

Parameters

camera	The IPylonDevice to work with.
interu	An Interruptable class that provides interruption functionality for the passed camera.

◆ ~PylonCameraOptions()

icl::io::pylon::PylonCameraOptions::~PylonCameraOptions ( )

Destructor.

Member Function Documentation

◆ acquisitionStart()

void icl::io::pylon::PylonCameraOptions::acquisitionStart ( )

Executes the ICommand 'AcquisitionStart'.

◆ acquisitionStop()

void icl::io::pylon::PylonCameraOptions::acquisitionStop ( )

Executes the ICommand 'AcquisitionStop'.

◆ addToPropertyList()

void icl::io::pylon::PylonCameraOptions::addToPropertyList	(	std::vector< std::string > &	ps,
		const GenApi::CNodePtr &	node
	)

private

helper function for getPropertyList.

◆ getCameraPixelSize()

int icl::io::pylon::PylonCameraOptions::getCameraPixelSize ( )

getter for cameras PixelSize in bits

◆ getCameraPixelType()

Pylon::PixelType icl::io::pylon::PylonCameraOptions::getCameraPixelType ( )

convenience function to get the cameras PixelType

◆ getFormatString()

std::string icl::io::pylon::PylonCameraOptions::getFormatString ( )

returns the cameras PixelFormat as string

◆ getHeight()

int icl::io::pylon::PylonCameraOptions::getHeight ( )

getter for the camera image height.

◆ getInfo()

std::string icl::io::pylon::PylonCameraOptions::getInfo ( const std::string & name )

private

get information of a properties valid values.

◆ getNeededBufferSize()

long icl::io::pylon::PylonCameraOptions::getNeededBufferSize ( )

getter of the BufferSize needed by the camera.

◆ getNode()

GenApi::INode* icl::io::pylon::PylonCameraOptions::getNode ( std::string name )

private

gets the corresponding CValuePtr to the passed name.

◆ getResultingFrameRateAbs()

double icl::io::pylon::PylonCameraOptions::getResultingFrameRateAbs ( )

getter for the current expected framerate

◆ getType()

std::string icl::io::pylon::PylonCameraOptions::getType ( const std::string & name )

private

get type of property.

◆ getValue()

std::string icl::io::pylon::PylonCameraOptions::getValue ( const std::string & name )

private

returns the current value of a property or a parameter.

◆ getWidth()

int icl::io::pylon::PylonCameraOptions::getWidth ( )

getter for the camera image width.

◆ isVolatile()

int icl::io::pylon::PylonCameraOptions::isVolatile ( const std::string & propertyName )

private

Returns whether this property may be changed internally.

◆ omitDoubleFrames()

bool icl::io::pylon::PylonCameraOptions::omitDoubleFrames ( )

whether double frames should be omitted.

◆ processPropertyChange()

void icl::io::pylon::PylonCameraOptions::processPropertyChange ( const utils::Configurable::Property & prop )

private

callback for changed configurable properties

Member Data Documentation

◆ m_Camera

Pylon::IPylonDevice* icl::io::pylon::PylonCameraOptions::m_Camera

private

The camera.

◆ m_Interu

Interruptable* icl::io::pylon::PylonCameraOptions::m_Interu

private

the Interruptable that provides interruption for the camera.

◆ m_OmitDoubleFrames

bool icl::io::pylon::PylonCameraOptions::m_OmitDoubleFrames

private

whether double frames should be omitted.

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

/Users/alneuman/vm/icl/ICLIO/src/ICLIO/PylonCameraOptions.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PylonCameraOptions()

◆ ~PylonCameraOptions()

Member Function Documentation

◆ acquisitionStart()

◆ acquisitionStop()

◆ addToPropertyList()

◆ getCameraPixelSize()

◆ getCameraPixelType()

◆ getFormatString()

◆ getHeight()

◆ getInfo()

◆ getNeededBufferSize()

◆ getNode()

◆ getResultingFrameRateAbs()

◆ getType()

◆ getValue()

◆ getWidth()

◆ isVolatile()

◆ omitDoubleFrames()

◆ processPropertyChange()

Member Data Documentation

◆ m_Camera

◆ m_Interu

◆ m_OmitDoubleFrames