Raytrix Light Field SDK  4.0
Logo
Public Member Functions | List of all members
Rx::LFR::CCamera Class Reference

Detailed Description

A camera.

Inherits Rx::LFR::CPimpl< CCamera_Impl, Interfaces::ECamera::ID >.

Public Member Functions

 CCamera ()
 Constructor. More...
 
 CCamera (CCamera &&xCamera)
 Move constructor. More...
 
 ~CCamera ()
 Destructor. More...
 
void AddImageCapturedCallback (TFuncImageCaptured pxCallback, void *pvContext)
 Adds the given callback function with the given context to the list of image captured callbacks. More...
 
void Close ()
 Closes the device and finalizes the communication. Does nothing if not open. More...
 
const CRxStringGetDriverName () const
 Gets the driver name, e.g. "TypeA". More...
 
const CRxImageFormatGetImageFormat () const
 Gets the format of the images captured by this camera. More...
 
CCamera_Impl & GetImpl ()
 Gets the non constant implementation. More...
 
const CCamera_Impl & GetImpl () const
 Gets the constant implementation. More...
 
unsigned GetIndex () const
 Gets the camera index. This is the index in the list of cameras in the camera server. More...
 
void * GetInterface (Interfaces::ECamera::ID eData)
 Gets the camera interface. More...
 
const void * GetInterface (Interfaces::ECamera::ID eData) const
 Gets the camera interface. More...
 
const CRxStringGetInternalSerial () const
 Gets the internal serial string. Is only available after the camera has been initialized. More...
 
void GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float &fValue)
 Gets a property value of type float. More...
 
void GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int &iValue)
 Gets a property value of type int. More...
 
void GetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, CRxString &sxValue) const
 Gets the value of a string property. More...
 
void GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, float &fMin, float &fMax)
 Gets the property value range of the given property of type float. More...
 
void GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, int &iMin, int &iMax)
 Gets the property value range of the given property of type int. More...
 
void GetPropertyRange (Interop::Runtime30::Camera::EProperty::ID eProp, CRxArrayInt &aiValue)
 Gets the possible values of an integer property. More...
 
bool HasInterface (Interfaces::ECamera::ID eInterface)
 Queries if this object has the given interface. More...
 
bool IsOpen () const
 Query if this camera is open. More...
 
bool IsPropertyAvailable (Interop::Runtime30::Camera::EProperty::ID eProp)
 Queries if a property is available. More...
 
void Open ()
 Opens the device and prepares the communication. More...
 
CCameraoperator= (CCamera &&xCamera)
 Move assignment operator. More...
 
void RemoveImageCapturedCallback (TFuncImageCaptured pxCallback)
 Removes the given callback function from the list of image captured callbacks. Does nothing if it's not in the list. More...
 
void SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, float fValue)
 Sets a property value of type float. More...
 
void SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, int iValue)
 Sets a property value of type int. More...
 
void SetProperty (Interop::Runtime30::Camera::EProperty::ID eProp, const CRxString &sxValue)
 Sets the value of a string property. More...
 
void Start ()
 Starts the camera. The configured trigger mode determines when the camera captures images. More...
 
void Start (Interop::Runtime30::Camera::ETriggerMode::ID eTriggerMode)
 Starts the camera. The given trigger mode determines when the camera captures images. More...
 
void Stop ()
 Stops the camera. More...
 
void Suspend (bool bSuspend)
 Suspends the camera. More...
 
void Trigger ()
 Triggers the camera. More...
 

Constructor & Destructor Documentation

Rx::LFR::CCamera::CCamera ( )

Constructor.

Rx::LFR::CCamera::CCamera ( CCamera &&  xCamera)

Move constructor.

Parameters
xCamera[in,out]The camera instance.
Rx::LFR::CCamera::~CCamera ( )

Destructor.

Member Function Documentation

void Rx::LFR::CCamera::AddImageCapturedCallback ( TFuncImageCaptured  pxCallback,
void *  pvContext 
)

Adds the given callback function with the given context to the list of image captured callbacks.

If the given callback function is already in the list, only the context is updated to the given one.

Parameters
pxCallbackThe callback function. Must not be null.
pvContext[in] The context pointer. Can be null.
void Rx::LFR::CCamera::Close ( )

Closes the device and finalizes the communication. Does nothing if not open.

const CRxString& Rx::LFR::CCamera::GetDriverName ( ) const

Gets the driver name, e.g. "TypeA".

Returns
The driver name.
const CRxImageFormat& Rx::LFR::CCamera::GetImageFormat ( ) const

Gets the format of the images captured by this camera.

Returns
The image format.
CCamera_Impl & Rx::LFR::CPimpl< CCamera_Impl , Interfaces::ECamera::ID >::GetImpl ( )
inlineinherited

Gets the non constant implementation.

Returns
The implementation.
const CCamera_Impl & Rx::LFR::CPimpl< CCamera_Impl , Interfaces::ECamera::ID >::GetImpl ( ) const
inlineinherited

Gets the constant implementation.

Returns
The implementation.
unsigned Rx::LFR::CCamera::GetIndex ( ) const

Gets the camera index. This is the index in the list of cameras in the camera server.

Returns
The index.
void* Rx::LFR::CCamera::GetInterface ( Interfaces::ECamera::ID  eData)

Gets the camera interface.

Parameters
eDataThe interface type.
Returns
Null if it fails, else the interface.
const void* Rx::LFR::CCamera::GetInterface ( Interfaces::ECamera::ID  eData) const

Gets the camera interface.

Parameters
eDataThe interface type.
Returns
Null if it fails, else the interface.
const CRxString& Rx::LFR::CCamera::GetInternalSerial ( ) const

Gets the internal serial string. Is only available after the camera has been initialized.

Returns
The internal serial.
void Rx::LFR::CCamera::GetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fValue 
)

Gets a property value of type float.

Parameters
eProp[in] The property in question.
fValue[out] The return value.
void Rx::LFR::CCamera::GetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iValue 
)

Gets a property value of type int.

Parameters
eProp[in] The property in question.
iValue[out] The return value.
void Rx::LFR::CCamera::GetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
CRxString sxValue 
) const

Gets the value of a string property.

Parameters
ePropThe property.
sxValue[out] The string value.
void Rx::LFR::CCamera::GetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float &  fMin,
float &  fMax 
)

Gets the property value range of the given property of type float.

Parameters
eProp[in] The property in question.
fMin[out] The minimum value for given property.
fMax[out] The maximum value for given property.
void Rx::LFR::CCamera::GetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int &  iMin,
int &  iMax 
)

Gets the property value range of the given property of type int.

Parameters
eProp[in] The property in question.
iMin[out] The minimum value for given property.
iMax[out] The maximum value for given property.
void Rx::LFR::CCamera::GetPropertyRange ( Interop::Runtime30::Camera::EProperty::ID  eProp,
CRxArrayInt aiValue 
)

Gets the possible values of an integer property.

Parameters
ePropThe property.
aiValue[out] The values.
bool Rx::LFR::CPimpl< CCamera_Impl , Interfaces::ECamera::ID >::HasInterface ( Interfaces::ECamera::ID  eInterface)
inlineinherited

Queries if this object has the given interface.

Parameters
eInterfaceThe interface to query.
Returns
True if this class has the given interface, false if not.
bool Rx::LFR::CCamera::IsOpen ( ) const

Query if this camera is open.

Returns
True if open, false if not.
bool Rx::LFR::CCamera::IsPropertyAvailable ( Interop::Runtime30::Camera::EProperty::ID  eProp)

Queries if a property is available.

Parameters
eProp[in] The property in question.
Returns
True if the property is available, false if not.
void Rx::LFR::CCamera::Open ( )

Opens the device and prepares the communication.

CCamera& Rx::LFR::CCamera::operator= ( CCamera &&  xCamera)

Move assignment operator.

Parameters
xCamera[in,out]The camera instance.
Returns
The instance.
void Rx::LFR::CCamera::RemoveImageCapturedCallback ( TFuncImageCaptured  pxCallback)

Removes the given callback function from the list of image captured callbacks. Does nothing if it's not in the list.

Parameters
pxCallbackThe callback function to remove.
void Rx::LFR::CCamera::SetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
float  fValue 
)

Sets a property value of type float.

Parameters
eProp[in] The property to be changed.
fValue[in] The value to be set.
void Rx::LFR::CCamera::SetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
int  iValue 
)

Sets a property value of type int.

Parameters
eProp[in] The property to be changed.
iValue[in] The value to be set.
void Rx::LFR::CCamera::SetProperty ( Interop::Runtime30::Camera::EProperty::ID  eProp,
const CRxString sxValue 
)

Sets the value of a string property.

Parameters
ePropThe property.
sxValueThe string value.
void Rx::LFR::CCamera::Start ( )

Starts the camera. The configured trigger mode determines when the camera captures images.

void Rx::LFR::CCamera::Start ( Interop::Runtime30::Camera::ETriggerMode::ID  eTriggerMode)

Starts the camera. The given trigger mode determines when the camera captures images.

Parameters
eTriggerModeThe trigger mode.
void Rx::LFR::CCamera::Stop ( )

Stops the camera.

void Rx::LFR::CCamera::Suspend ( bool  bSuspend)

Suspends the camera.

Parameters
bSuspendTrue to suspend, false to unsuspend.
void Rx::LFR::CCamera::Trigger ( )

Triggers the camera.