icl::io::pylon::PylonCameraOptions Class Reference

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

#include <PylonCameraOptions.h>

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

List of all members.

Public Member Functions
	PylonCameraOptions (Pylon::IPylonDevice *camera, Interruptable *interu)
	Constructor.
	~PylonCameraOptions ()
	Destructor.
Pylon::PixelType	getCameraPixelType ()
	convenience function to get the cameras PixelType
int	getCameraPixelSize ()
	getter for cameras PixelSize in bits
long	getNeededBufferSize ()
	getter of the BufferSize needed by the camera.
void	acquisitionStart ()
	Executes the ICommand 'AcquisitionStart'.
void	acquisitionStop ()
	Executes the ICommand 'AcquisitionStop'.
int	getHeight ()
	getter for the camera image height.
int	getWidth ()
	getter for the camera image width.
std::string	getFormatString ()
	returns the cameras PixelFormat as string
bool	omitDoubleFrames ()
	whether double frames should be omitted.
double	getResultingFrameRateAbs ()
	getter for the current expected framerate
Private Member Functions
std::string	getType (const std::string &name)
	get type of property.
std::string	getInfo (const std::string &name)
	get information of a properties valid values.
std::string	getValue (const std::string &name)
	returns the current value of a property or a parameter.
int	isVolatile (const std::string &propertyName)
	Returns whether this property may be changed internally.
void	processPropertyChange (const utils::Configurable::Property &prop)
	callback for changed configurable properties
void	addToPropertyList (std::vector< std::string > &ps, const GenApi::CNodePtr &node)
	helper function for getPropertyList.
GenApi::INode *	getNode (std::string name)
	gets the corresponding CValuePtr to the passed name.
Private Attributes
Interruptable *	m_Interu
	the Interruptable that provides interruption for the camera.
Pylon::IPylonDevice *	m_Camera
	The camera.
bool	m_OmitDoubleFrames
	whether double frames should be omitted.

---

Detailed Description

This is a helper class for Pylon camera settings.

---

Constructor & Destructor Documentation

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.

icl::io::pylon::PylonCameraOptions::~PylonCameraOptions

(

)

Destructor.

---

Member Function Documentation

void icl::io::pylon::PylonCameraOptions::acquisitionStart

(

)

Executes the ICommand 'AcquisitionStart'.

void icl::io::pylon::PylonCameraOptions::acquisitionStop

(

)

Executes the ICommand 'AcquisitionStop'.

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

helper function for getPropertyList.

int icl::io::pylon::PylonCameraOptions::getCameraPixelSize

(

)

getter for cameras PixelSize in bits

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

(

)

convenience function to get the cameras PixelType

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

(

)

returns the cameras PixelFormat as string

int icl::io::pylon::PylonCameraOptions::getHeight

(

)

getter for the camera image height.

std::string icl::io::pylon::PylonCameraOptions::getInfo

(

const std::string &

name

)

[private]

get information of a properties valid values.

long icl::io::pylon::PylonCameraOptions::getNeededBufferSize

(

)

getter of the BufferSize needed by the camera.

GenApi::INode* icl::io::pylon::PylonCameraOptions::getNode

(

std::string

name

)

[private]

gets the corresponding CValuePtr to the passed name.

double icl::io::pylon::PylonCameraOptions::getResultingFrameRateAbs

(

)

getter for the current expected framerate

std::string icl::io::pylon::PylonCameraOptions::getType

(

const std::string &

name

)

[private]

get type of property.

std::string icl::io::pylon::PylonCameraOptions::getValue

(

const std::string &

name

)

[private]

returns the current value of a property or a parameter.

int icl::io::pylon::PylonCameraOptions::getWidth

(

)

getter for the camera image width.

int icl::io::pylon::PylonCameraOptions::isVolatile

(

const std::string &

propertyName

)

[private]

Returns whether this property may be changed internally.

bool icl::io::pylon::PylonCameraOptions::omitDoubleFrames

(

)

whether double frames should be omitted.

void icl::io::pylon::PylonCameraOptions::processPropertyChange

(

const utils::Configurable::Property &

prop

)

[private]

callback for changed configurable properties

---

Member Data Documentation

Pylon::IPylonDevice* icl::io::pylon::PylonCameraOptions::m_Camera [private]

The camera.

Interruptable* icl::io::pylon::PylonCameraOptions::m_Interu [private]

the Interruptable that provides interruption for the camera.

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:

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLIO/src/ICLIO/PylonCameraOptions.h