siso_genicam.h Source File |
siso_genicam.h
Go to the documentation of this file.
202typedef int (*SgcEventCallback_t)(SgcBoardHandle* boardHandle, SgcCameraHandle* cameraHandle , const SgcEventInfo * const eventInfo, const void* userData);
213typedef int (*Sgc_BoardEventCallbackFunc_t)(SgcBoardHandle* boardHandle, const SgcEventInfo* eventInfo, void* userData);
224typedef int (*Sgc_CameraEventCallbackFunc_t)(SgcCameraHandle *cameraHandle, const SgcEventInfo * eventInfo, void* userData);
369/* These defines are deprecated and kept for backwards code compatibility; use the defines without _S */
435 int Sgc_initBoardEx(Fg_Struct* fg, unsigned int initFlag, SgcBoardHandle** boardHandle, unsigned int portMask, unsigned int slaveMode);
465 int Sgc_scanPorts(SgcBoardHandle* boardHandle, const unsigned int portMask, const int discoveryTimeout, const int speed);
489 int Sgc_scanPortsEx(SgcBoardHandle* boardHandle, const unsigned int portMask, const int discoveryTimeout, const int speed, const unsigned int flags);
512 unsigned int Sgc_isCameraAvailableAtIndex(SgcBoardHandle* boardHandle, const unsigned int index);
534 int Sgc_getCameraByIndex(SgcBoardHandle* boardHandle, const unsigned int index, SgcCameraHandle** cameraHandle);
553 int Sgc_getCamera(SgcBoardHandle* boardHandle, const unsigned int port, SgcCameraHandle** cameraHandle);
667 int Sgc_powerSwitchExt(SgcBoardHandle *boardHandle, const unsigned int portMask, const unsigned int command);
682 int DEPRECATED(Sgc_RegisterEventCallback(SgcBoardHandle *boardHandle, SgcEventCallback_t eventHandler, void* userData));
697 int Sgc_registerBoardEventCallback(SgcBoardHandle* board_handle, Sgc_BoardEventCallbackFunc_t eventHandler, void* userData);
712 int Sgc_registerCameraEventCallback(SgcCameraHandle* camera_handle, Sgc_CameraEventCallbackFunc_t eventHandler, void* userData);
748 int Sgc_getIntegerValue(SgcCameraHandle* cameraHandle, const char* featureName, int64_t* valuePtr);
768 int Sgc_getIntegerValueLimits(SgcCameraHandle* cameraHandle, const char* featureName, int64_t* min_valuePtr, int64_t* max_valuePtr, int64_t* step_valuePtr);
788 int Sgc_getFloatValueLimits(SgcCameraHandle* cameraHandle, const char* featureName, double* min_valuePtr, double* max_valuePtr, double* step_valuePtr);
805 int Sgc_setBooleanValue(SgcCameraHandle* cameraHandle, const char* featureName, unsigned int value);
822 int Sgc_getBooleanValue(SgcCameraHandle* cameraHandle, const char* featureName, unsigned int* valuePtr);
852 int Sgc_getFloatValue(SgcCameraHandle* cameraHandle, const char* featureName, double* valuePtr);
872 int Sgc_setStringValue(SgcCameraHandle* cameraHandle, const char* featureName, const char* value);
890 int Sgc_getStringValue(SgcCameraHandle* cameraHandle, const char* featureName, const char** valuePtr);
907 int Sgc_setEnumerationValue(SgcCameraHandle* cameraHandle, const char* featureName, const char* value);
924 int Sgc_getEnumerationValue(SgcCameraHandle* cameraHandle, const char* featureName, int64_t* value);
941 int Sgc_getEnumerationValueAsString(SgcCameraHandle* cameraHandle, const char* featureName, const char** valuePtr);
982 int Sgc_isCommandDone(SgcCameraHandle* cameraHandle, const char* featureName, unsigned int* valuePtr);
1039 int Sgc_setGenICamXML(SgcCameraHandle* cameraHandle, const char* buffer, const size_t bufferSize);
1069 int Sgc_registerReadFromCamera(SgcCameraHandle* cameraHandle, uint32_t* data, uint64_t address);
1105 int Sgc_stringReadFromCamera(SgcCameraHandle* cameraHandle, char* data, uint64_t address, unsigned int length);
1112 int Sgc_memoryReadFromCamera(SgcCameraHandle* cameraHandle, void* buffer, uint64_t address, size_t length);
1119 int Sgc_memoryWriteToCamera(SgcCameraHandle* cameraHandle, const void* buffer, uint64_t address, size_t length);
1141 int Sgc_memoryReadFromCameraWithTimeout(SgcCameraHandle* cameraHandle, void* buffer, uint64_t address, size_t length, uint32_t timeoutInMilliseconds);
1161 int Sgc_memoryWriteToCameraWithTimeout(SgcCameraHandle* cameraHandle, const void* buffer, uint64_t address, size_t length, uint32_t timeoutInMilliseconds);
1189 int Sgc_getCameraPropertyWithType(SgcCameraHandle* cameraHandle, const char* propertyName, void* value, unsigned int* propertyType, void* additionalValue);
1217 int Sgc_setCameraPropertyWithType(SgcCameraHandle* cameraHandle, const char* propertyName, const void* value, unsigned int propertyType, void* additionalValue);
1243 int Sgc_setBoardPropertyWithType(SgcBoardHandle* boardHandle, const char* propertyName, const void* propertyValuePtr, unsigned int propertyType, void* additionalValue);
1269 int Sgc_getBoardPropertyWithType(SgcBoardHandle* boardHandle, const char* propertyName, const void* value, unsigned int propertyType, const void* additionalValue);
1329 int DEPRECATED(Sgc_DirectRegisterRead(SgcBoardHandle* boardHandle, const unsigned int port, const uint32_t address, uint32_t* data));
1345 int Sgc_DirectRegisterRead64(SgcBoardHandle* boardHandle, const unsigned int port, const uint64_t address, uint32_t* data);
1354 int DEPRECATED(Sgc_DirectRegisterWrite(SgcBoardHandle* boardHandle, const unsigned int port, const uint32_t address, const uint32_t data, const unsigned int switchByteOrder));
1372 int Sgc_DirectRegisterWrite64(SgcBoardHandle* boardHandle, const unsigned int port, const uint64_t address, const uint32_t data, const unsigned int switchByteOrder);
1381 int DEPRECATED(Sgc_DirectRegisterReadMem(SgcBoardHandle *boardHandle, const unsigned int port, const uint32_t address, unsigned char* data, uint32_t* buflen));
1399 int Sgc_DirectRegisterReadMem64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, unsigned char* data, uint32_t* buflen);
1408 int DEPRECATED(Sgc_DirectRegisterWriteMem(SgcBoardHandle *boardHandle, const unsigned int port, const uint32_t address, const unsigned char* data, const uint32_t buflen ));
1426 int Sgc_DirectRegisterWriteMem64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, const unsigned char* data, const uint32_t buflen );
1435 int DEPRECATED(Sgc_DirectRegisterReadMemWithTimeOut(SgcBoardHandle *boardHandle, const unsigned int port, const uint32_t address, unsigned char* data, uint32_t* buflen, uint32_t timeoutInMilliseconds));
1454 int Sgc_DirectRegisterReadMemWithTimeOut64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, unsigned char* data, uint32_t* buflen, uint32_t timeoutInMilliseconds);
1463 int DEPRECATED(Sgc_DirectRegisterWriteMemWithTimeOut(SgcBoardHandle *boardHandle, const unsigned int port, const uint32_t address, const unsigned char* data, const uint32_t buflen, uint32_t timeoutInMilliseconds));
1484 int Sgc_DirectRegisterWriteMemWithTimeOut64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, const unsigned char* data, const uint32_t buflen, uint32_t timeoutInMilliseconds);
1510 int DEPRECATED(Sgc_SaveBoardConfiguration(SgcBoardHandle* board_handle, const char* configFileName));
1535 int DEPRECATED(Sgc_LoadBoardConfiguration(SgcBoardHandle* board_handle, const char* configFileName));
1555 int Sgc_SaveCameraParameters(SgcCameraHandle* cameraHandle, const char* paramFileName, uint32_t flags);
1573 int Sgc_LoadCameraParameters(SgcCameraHandle* cameraHandle, const char* paramFileName, uint32_t flags);
1591int Sgc_LoadConnectionProfile(Fg_Struct* fg, const char* boardConfigurationFilePath, SgcConnectionProfile** connectionProfilePtr);
struct declarations. int Sgc_isCommandDone(SgcCameraHandle *cameraHandle, const char *featureName, unsigned int *valuePtr) Check, if a GenICam command is performed completely. const char * Sgc_getErrorDescription(const int errorCode) returns a descriptive text for the error code int(* Sgc_CameraEventCallbackFunc_t)(SgcCameraHandle *cameraHandle, const SgcEventInfo *eventInfo, void *userData) prototype of camera event callback procedure Definition siso_genicam.h:224 unsigned int Sgc_isCameraAvailableAtIndex(SgcBoardHandle *boardHandle, const unsigned int index) Check for camera. int Sgc_RestoreLowLevelLinkProfile(SgcBoardHandle *boardHandle, const char *file) restore low level link profile from file to board int Sgc_clearStringCache(SgcCameraHandle *cameraHandle) Clear the internal cache for GenICam string representations. int Sgc_LinkDisconnect(SgcCameraHandle *cameraHandle) disconnects a camera handle from a GenICam capable camera int Sgc_UnloadConnectionProfile(SgcConnectionProfile *connectionProfile) unload a connection profile int Sgc_getFloatValue(SgcCameraHandle *cameraHandle, const char *featureName, double *valuePtr) Read GenICam floating point value at camera. void Sgc_freeBoard(SgcBoardHandle *boardHandle) Release resources allocated by Sgc_initBoard. int Sgc_startAcquisition(SgcCameraHandle *cameraHandle, unsigned int startCamera) activates the the data flow towards the applet and activates the image acquisition at the camera This... int Sgc_registerWriteToCamera(SgcCameraHandle *cameraHandle, uint32_t data, uint64_t address) write a 32 bit integer value to a camera register int Sgc_DirectRegisterWriteMem64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, const unsigned char *data, const uint32_t buflen) write a block of data to the camera int Sgc_DirectRegisterRead64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, uint32_t *data) reads an integer value to the camera int Sgc_setIntegerValue(SgcCameraHandle *cameraHandle, const char *featureName, int64_t value) Set GenICam Integer value at camera. int Sgc_connectCamera(SgcCameraHandle *cameraHandle) Connect to camera by downloading the cameras internal GenICam XML file A call of this function is nec... int Sgc_getCamera(SgcBoardHandle *boardHandle, const unsigned int port, SgcCameraHandle **cameraHandle) get a camera object associated to a certain frame grabber port unsigned int Sgc_isCameraAvailable(SgcBoardHandle *boardHandle, const unsigned int port) Check for camera. int Sgc_memoryReadFromCamera(SgcCameraHandle *cameraHandle, void *buffer, uint64_t address, size_t length) read a number of bytes from a camera register without a timeout int Sgc_LoadCameraParameters(SgcCameraHandle *cameraHandle, const char *paramFileName, uint32_t flags) load the current camera parameters from a file int Sgc_stringReadFromCamera(SgcCameraHandle *cameraHandle, char *data, uint64_t address, unsigned int length) read a string value from a camera register This function can be used for a direct access to a camera ... int Sgc_executeCommand(SgcCameraHandle *cameraHandle, const char *featureName) Execute a certain GenICam command at the camera. int Sgc_powerSwitch(SgcBoardHandle *boardHandle, const unsigned int portMask) switch on Power over CoaxPress/CameraLink/... int Sgc_memoryWriteToCameraWithTimeout(SgcCameraHandle *cameraHandle, const void *buffer, uint64_t address, size_t length, uint32_t timeoutInMilliseconds) write a number of bytes to a camera register int Sgc_setBooleanValue(SgcCameraHandle *cameraHandle, const char *featureName, unsigned int value) Set GenICam boolean value at camera. int(* Sgc_BoardEventCallbackFunc_t)(SgcBoardHandle *boardHandle, const SgcEventInfo *eventInfo, void *userData) prototype of board event callback procedure Definition siso_genicam.h:213 int Sgc_getCameraByIndex(SgcBoardHandle *boardHandle, const unsigned int index, SgcCameraHandle **cameraHandle) get a handle of the currently detected cameras int Sgc_updateCameraInfos(SgcCameraHandle *cameraHandle) update the informations of the camera handle struct SgcEventInfo SgcEventInfo data structure for events received from the board callback functions int Sgc_getGenICamXML(SgcCameraHandle *cameraHandle, char *buffer, size_t *bufferSize) returns the currently loaded GenICam-XML SgcCameraInfo * Sgc_getCameraInfo(SgcCameraHandle *cameraHandle) get manufacturer information from connected camera. int Sgc_DirectRegisterWriteMemWithTimeOut64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, const unsigned char *data, const uint32_t buflen, uint32_t timeoutInMilliseconds) write a block of data to the camera int Sgc_setCameraPropertyWithType(SgcCameraHandle *cameraHandle, const char *propertyName, const void *value, unsigned int propertyType, void *additionalValue) set camera or camera connection specific properties int Sgc_StoreLowLevelLinkProfile(SgcBoardHandle *boardHandle, const char *file) store current low level link profile into file int Sgc_getCameraCount(SgcBoardHandle *boardHandle) get number of the currently detected cameras int Sgc_DirectRegisterReadMemWithTimeOut64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, unsigned char *data, uint32_t *buflen, uint32_t timeoutInMilliseconds) write a block of data to the camera int Sgc_memoryReadFromCameraWithTimeout(SgcCameraHandle *cameraHandle, void *buffer, uint64_t address, size_t length, uint32_t timeoutInMilliseconds) read a number of bytes from a camera register int Sgc_memoryWriteToCamera(SgcCameraHandle *cameraHandle, const void *buffer, uint64_t address, size_t length) write a number of bytes to a camera register without a timeout int Sgc_connectCameraWithExternalXml(SgcCameraHandle *cameraHandle, const char *filename) Connect to Camera by using a certain GenICam XML File from the hard disk. int(* SgcEventCallback_t)(SgcBoardHandle *boardHandle, SgcCameraHandle *cameraHandle, const SgcEventInfo *const eventInfo, const void *userData) prototype of event callback procedure Definition siso_genicam.h:202 int Sgc_powerSwitchExt(SgcBoardHandle *boardHandle, const unsigned int portMask, const unsigned int command) switch on Power over CoaxPress int Sgc_registerCameraEventCallback(SgcCameraHandle *camera_handle, Sgc_CameraEventCallbackFunc_t eventHandler, void *userData) Register an callback procedure for camera event notifications. int Sgc_scanPortsEx(SgcBoardHandle *boardHandle, const unsigned int portMask, const int discoveryTimeout, const int speed, const unsigned int flags) Scans the defined ports of the frame grabber for present cameras. int Sgc_setStringValue(SgcCameraHandle *cameraHandle, const char *featureName, const char *value) Set GenICam string value at camera. int Sgc_DirectRegisterReadMem64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, unsigned char *data, uint32_t *buflen) write a block of data to the camera int Sgc_getBoardPropertyWithType(SgcBoardHandle *boardHandle, const char *propertyName, const void *value, unsigned int propertyType, const void *additionalValue) get a global board property int Sgc_getEnumerationValue(SgcCameraHandle *cameraHandle, const char *featureName, int64_t *value) Read GenICam integer representation of enumeration value from camera. int Sgc_getCameraPropertyWithType(SgcCameraHandle *cameraHandle, const char *propertyName, void *value, unsigned int *propertyType, void *additionalValue) get camera specific properties int DEPRECATED(Sgc_RegisterEventCallback(SgcBoardHandle *boardHandle, SgcEventCallback_t eventHandler, void *userData)) Register an callback procedure for event notifications. int Sgc_setBoardPropertyWithType(SgcBoardHandle *boardHandle, const char *propertyName, const void *propertyValuePtr, unsigned int propertyType, void *additionalValue) set global board properties int Sgc_getEnumerationValueAsString(SgcCameraHandle *cameraHandle, const char *featureName, const char **valuePtr) Read GenICam string representation of enumeration value from camera. int Sgc_registerReadFromCamera(SgcCameraHandle *cameraHandle, uint32_t *data, uint64_t address) read a 32 bit integer value from a camera register int Sgc_initBoard(Fg_Struct *fg, unsigned int initFlag, SgcBoardHandle **boardHandle) Create an Interface object for accessing cameras connected to a frame grabber. int Sgc_getBooleanValue(SgcCameraHandle *cameraHandle, const char *featureName, unsigned int *valuePtr) Read GenICam boolean value at camera. int Sgc_registerBoardEventCallback(SgcBoardHandle *board_handle, Sgc_BoardEventCallbackFunc_t eventHandler, void *userData) Register an callback procedure for board event notifications. int Sgc_LinkConnect(SgcBoardHandle *boardHandle, SgcCameraHandle *cameraHandle) connects a camera handle a GenICam capable camera int Sgc_getFloatValueLimits(SgcCameraHandle *cameraHandle, const char *featureName, double *min_valuePtr, double *max_valuePtr, double *step_valuePtr) Read GenICam Float value limits and increment. int Sgc_setGenICamXML(SgcCameraHandle *cameraHandle, const char *buffer, const size_t bufferSize) sets the currently GenICam-XML from a buffer int Sgc_setFloatValue(SgcCameraHandle *cameraHandle, const char *featureName, double value) Set GenICam floating point value at camera. int Sgc_scanPorts(SgcBoardHandle *boardHandle, const unsigned int portMask, const int discoveryTimeout, const int speed) Scans the defined ports of the frame grabber for present cameras. int Sgc_LoadConnectionProfile(Fg_Struct *fg, const char *boardConfigurationFilePath, SgcConnectionProfile **connectionProfilePtr) load a connection profile struct SgcConnectionProfile SgcConnectionProfile data structure representing the state of a loaded connection profile int Sgc_getStringValue(SgcCameraHandle *cameraHandle, const char *featureName, const char **valuePtr) Read GenICam string value from camera. int Sgc_getIntegerValue(SgcCameraHandle *cameraHandle, const char *featureName, int64_t *valuePtr) Read GenICam Integer value from camera. int Sgc_SaveCameraParameters(SgcCameraHandle *cameraHandle, const char *paramFileName, uint32_t flags) save the current camera parameters to a file int Sgc_getIntegerValueLimits(SgcCameraHandle *cameraHandle, const char *featureName, int64_t *min_valuePtr, int64_t *max_valuePtr, int64_t *step_valuePtr) Read GenICam Integer value from camera. int Sgc_stopAcquisition(SgcCameraHandle *cameraHandle, unsigned int stopCamera) stops the the data flow towards the applet and stops the image acquisition at the camera (optionally) int Sgc_loadCameraXml(SgcCameraHandle *cameraHandle) Downloading the cameras internal GenICam XML file. A call of this function with a connectToGenAPI set... int Sgc_DirectRegisterWrite64(SgcBoardHandle *boardHandle, const unsigned int port, const uint64_t address, const uint32_t data, const unsigned int switchByteOrder) write a block of data to the camera int Sgc_initBoardEx(Fg_Struct *fg, unsigned int initFlag, SgcBoardHandle **boardHandle, unsigned int portMask, unsigned int slaveMode) Create an Interface object for accessing cameras connected to a frame grabber. int Sgc_callInternalFunction(int id, const void *const in, void *const out) int Sgc_setEnumerationValue(SgcCameraHandle *cameraHandle, const char *featureName, const char *value) Set GenICam enumeration value at camera. Error codes returned by the library siso_genicam. const char * deviceManufacturerInfo Definition siso_genicam.h:40 data structure representing the state of a loaded connection profile Definition siso_genicam.h:169 int * cameraConnectionStates Definition siso_genicam.h:174 Definition siso_genicam.h:120 Definition siso_genicam.h:129 uint32_t properties_string_count Definition siso_genicam.h:134 char ** properties_int_key Definition siso_genicam.h:132 char ** properties_string_key Definition siso_genicam.h:135 uint32_t properties_int_count Definition siso_genicam.h:131 uint32_t * properties_int_value Definition siso_genicam.h:133 char ** properties_string_value Definition siso_genicam.h:136 Definition siso_genicam.h:124 uint32_t linkConnectionState Definition siso_genicam.h:126 data structure for events received from the board callback functions Definition siso_genicam.h:157 Definition siso_genicam.h:139 SgcEventData_DiscoveryStateChanged discovery_state Definition siso_genicam.h:142 SgcEventData_ConnectionLost camera_connection_lost Definition siso_genicam.h:140 SgcEventData_LinkConnectionStateChanged link_connection_state_changed Definition siso_genicam.h:141 |