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 CRxString & | GetDriverName () const |
Gets the driver name, e.g. "TypeA". More... | |
const CRxImageFormat & | GetImageFormat () 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 CRxString & | GetInternalSerial () 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... | |
CCamera & | operator= (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... | |
Rx::LFR::CCamera::CCamera | ( | ) |
Constructor.
Rx::LFR::CCamera::CCamera | ( | CCamera && | xCamera | ) |
Move constructor.
xCamera | [in,out]The camera instance. |
Rx::LFR::CCamera::~CCamera | ( | ) |
Destructor.
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.
pxCallback | The 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".
const CRxImageFormat& Rx::LFR::CCamera::GetImageFormat | ( | ) | const |
Gets the format of the images captured by this camera.
|
inlineinherited |
Gets the non constant implementation.
|
inlineinherited |
Gets the constant implementation.
unsigned Rx::LFR::CCamera::GetIndex | ( | ) | const |
Gets the camera index. This is the index in the list of cameras in the camera server.
void* Rx::LFR::CCamera::GetInterface | ( | Interfaces::ECamera::ID | eData | ) |
Gets the camera interface.
eData | The interface type. |
const void* Rx::LFR::CCamera::GetInterface | ( | Interfaces::ECamera::ID | eData | ) | const |
Gets the camera interface.
eData | The interface type. |
const CRxString& Rx::LFR::CCamera::GetInternalSerial | ( | ) | const |
Gets the internal serial string. Is only available after the camera has been initialized.
void Rx::LFR::CCamera::GetProperty | ( | Interop::Runtime30::Camera::EProperty::ID | eProp, |
float & | fValue | ||
) |
Gets a property value of type float.
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.
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.
eProp | The 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.
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.
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.
eProp | The property. |
aiValue | [out] The values. |
|
inlineinherited |
Queries if this object has the given interface.
eInterface | The interface to query. |
bool Rx::LFR::CCamera::IsOpen | ( | ) | const |
Query if this camera is open.
bool Rx::LFR::CCamera::IsPropertyAvailable | ( | Interop::Runtime30::Camera::EProperty::ID | eProp | ) |
Queries if a property is available.
eProp | [in] The property in question. |
void Rx::LFR::CCamera::Open | ( | ) |
Opens the device and prepares the communication.
Move assignment operator.
xCamera | [in,out]The camera 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.
pxCallback | The callback function to remove. |
void Rx::LFR::CCamera::SetProperty | ( | Interop::Runtime30::Camera::EProperty::ID | eProp, |
float | fValue | ||
) |
Sets a property value of type float.
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.
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.
eProp | The property. |
sxValue | The 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.
eTriggerMode | The trigger mode. |
void Rx::LFR::CCamera::Stop | ( | ) |
Stops the camera.
void Rx::LFR::CCamera::Suspend | ( | bool | bSuspend | ) |
Suspends the camera.
bSuspend | True to suspend, false to unsuspend. |
void Rx::LFR::CCamera::Trigger | ( | ) |
Triggers the camera.