///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Copyright (c) 2013 Raytrix GmbH. All rights reserved. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// #pragma once #include "Rx.Interop.Runtime30/CameraProperties.h" namespace Rx { namespace Interop { namespace Runtime28 { namespace EPixelType { enum ID; } namespace EDataType { enum ID; } } } } ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // namespace: Rx.Interop.Runtime30.Camera ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// namespace Rx { namespace Interop { namespace Runtime30 { namespace Camera { ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Interface for native device class. This base provides functionality for using devices independently of their hardware /// interface type. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// class INativeDeviceControl { protected: virtual ~INativeDeviceControl() { }; public: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Opens the device and prepares the communication. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void Open() = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Closes the device and finalizes the communication. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void Close() = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Starts the acquisition of images. /// /// This has to be called for image acquisition unrelated to the trigger mode used. The trigger mode has to be set while /// not capturing. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void StartCapture() = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Suspends the capturing. /// /// With most cameras this just pauses the passing of the images while other cameras implement a real suspend which saves /// energy. /// /// /// [in] true to suspend. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void SuspendCapture(bool bSuspend) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets information about the image type the camera delivers. The camera must be open before calling this function. /// /// /// [out] The pixeltype. /// [out] The datatype. /// [out] The number of bytes per pixel. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void GetImageType(Interop::Runtime28::EPixelType::ID& ePixelType, Interop::Runtime28::EDataType::ID& eDataType, int& iBytesPerPixel) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Stops the acquisition of images. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void StopCapture() = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Triggers an image capture. /// /// In video mode it does nothing. In single capture mode performs a software trigger. Camera has to be open and should be /// capturing in software trigger mode. /// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void Trigger() = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Queries if a property is available. /// /// /// [in] The property in question. /// /// True if the property is available, false if not. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual bool IsPropertyAvailable(Interop::Runtime30::Camera::EProperty::ID eProp) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets a property value of type float. /// /// /// [in] The property in question. /// [out] The return value. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void GetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, float& fValue) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets a property value of type int. /// /// /// [in] The property in question. /// [out] The return value. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void GetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, int& iValue) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets a property value of type string. /// /// To obtain the required buffer size, call this with pcValue = null. /// /// /// [in] The property in question. /// [out] The user managed buffer that is used for storing the value. /// The size of the given buffer in bytes. /// /// The number of bytes that is required to store the resultig string in pcValue, including the terminating 0. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual int GetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, char* pcValue, int iBufferSize) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Sets a property value of type float. /// /// /// [in] The property to be changed. /// [in] The value to be set. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void SetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, float fValue) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Sets a property value of type int. /// /// /// [in] The property to be changed. /// [in] The value to be set. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void SetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, int iValue) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Sets a property value of type string. /// /// /// The property to be changed. /// [in] The value to be set. This is a null terminated string. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void SetProperty(Interop::Runtime30::Camera::EProperty::ID eProp, const char* pcValue) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets the property value range of the given property of type float. /// /// /// [in] The property in question. /// [out] The minimum value for given property. /// [out] The maximum value for given property. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void GetPropertyRange(Interop::Runtime30::Camera::EProperty::ID eProp, float& fMin, float& fMax) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets the property value range of the given property of type int. /// /// /// [in] The property in question. /// [out] The minimum value for given property. /// [out] The maximum value for given property. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual void GetPropertyRange(Interop::Runtime30::Camera::EProperty::ID eProp, int& iMin, int& iMax) = 0; ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /// /// Gets the property value range of the given arguments of type array int. /// /// /// [in] The property in question. /// [out] The pointer to an array that contains the list of available values. The pointer has to point /// to an array with iMaxValueCnt elements. The parameter iTotalValueCnt contains the total number /// of available properties. If a null pointer is passed here, only the total number of available /// parameters is returned in iTotalValueCnt. /// The number of values that can be stored in piValues. /// /// The number of integers that is required to store all available values. ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// virtual int GetPropertyRange(Interop::Runtime30::Camera::EProperty::ID eProp, int* piValues, int iNumValues) = 0; }; } } } } #pragma make_public(Rx::Interop::Runtime30::Camera::INativeDeviceControl)