CLProtocol.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2008 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Fritz Dierks
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group. 
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'. 
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
// 
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR  
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP 
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL, 
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO, 
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS; 
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY, 
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) 
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef CLPROTOCOL_CLPROTOCOL_H
#define CLPROTOCOL_CLPROTOCOL_H

#include <CLProtocol/ClSerialTypes.h>

#include <stdarg.h>

//==============================================================================
//  Macros 
//==============================================================================

#if (defined(__cplusplus) || defined(__cplusplus__))
    #define USER_EXTERN_C extern "C"
    #define USER_EXTERN_C_START extern "C" {
    #define USER_EXTERN_C_END }
#else
    #define USER_EXTERN_C
    #define USER_EXTERN_C_START
    #define USER_EXTERN_C_END
#endif

#ifdef CLPROTOCOL_EXPORTS
    #if defined(_WIN32)
        #define CLPROTOCOLEXPORT USER_EXTERN_C __declspec(dllexport)
        #define CLPROTOCOL_DECL __declspec(dllexport)
    #else
        #define CLPROTOCOLEXPORT USER_EXTERN_C __attribute__((visibility("default")))
        #define CLPROTOCOL_DECL __attribute__((visibility("default")))
    #endif
#else
    #if defined(_WIN32)
        #define CLPROTOCOLEXPORT USER_EXTERN_C __declspec(dllimport)
        #define CLPROTOCOL_DECL __declspec(dllimport)
    #else
        #define CLPROTOCOLEXPORT USER_EXTERN_C __attribute__((visibility("default")))
        #define CLPROTOCOL_DECL __attribute__((visibility("default")))
    #endif
#endif

#ifndef CLPROTOCOL
    #if defined(_WIN32)
        #define CLPROTOCOL __cdecl
    #else
        #if !defined(__x86_64) && !defined(__arm__) && !defined(__aarch64__) && !defined(VXWORKS)
            #define  CLPROTOCOL __attribute__((cdecl))
        #else
            #define  CLPROTOCOL  /* use default calling convention */
        #endif
    #endif
#endif

//==============================================================================
//  Types and Enums
//==============================================================================

typedef void (CLPROTOCOL *clp_logger_t)( CLINT32 level, const char* stringFormat, va_list argptr);
USER_EXTERN_C_START
    typedef struct clpLogCallback_t
    {
        CLUINT32 id;           
        clp_logger_t logger;   
    }clpLogCallback_t;
USER_EXTERN_C_END

enum CLP_PARAMS
{
// Global parameters that do not use the Cookie when called.
    CLP_LOG_LEVEL            = 1,   

    CLP_LOG_CALLBACK         = 2,   

    CLP_STOP_PROBE_DEVICE    = 3,   

    // Device related parameters that require a valid cookie to execute properly.
    CLP_DEVICE_BAUDERATE     = -1,  
                                    
    CLP_DEVICE_SUPPORTED_BAUDERATES = -2  
};

enum CLP_LOG_LEVEL_VALUE
{ 
    CLP_LOG_FATAL  = 0,
    CLP_LOG_ALERT  = 100,
    CLP_LOG_CRIT   = 200,
    CLP_LOG_ERROR  = 300, 
    CLP_LOG_WARN   = 400,
    CLP_LOG_NOTICE = 500,
    CLP_LOG_INFO   = 600,
    CLP_LOG_DEBUG  = 700,
    CLP_LOG_NOTSET = 800
};

//==============================================================================
//  Exported Functions
//==============================================================================

class ISerial;



CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpInitLib( clp_logger_t logger, 
            CLP_LOG_LEVEL_VALUE logLevel);

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpCloseLib( void );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL clpGetShortDeviceIDTemplates ( CLINT8* pShortDeviceTemplates, CLUINT32* pBufferSize );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL clpProbeDevice( ISerial *pSerial, const CLINT8* pDeviceIDTemplate, CLINT8* pDeviceID, CLUINT32 *pBufferSize, CLUINT32 *pCookie, const CLUINT32 TimeOut );


CLPROTOCOLEXPORT CLINT32 CLPROTOCOL clpGetXMLIDs ( ISerial *pSerial, const CLUINT32 Cookie, CLINT8* pXMLIDs, CLUINT32* pBufferSize, const CLUINT32 TimeOut );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpGetXMLDescription( ISerial *pSerial, const CLUINT32 Cookie, const CLINT8* pXMLID, CLINT8* pXMLBuffer, CLUINT32* pBufferSize, const CLUINT32 TimeOut );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL
clpReadRegister(ISerial *pSerial, const CLUINT32 Cookie, const CLINT64 Address, CLINT8* pBuffer, const CLINT64 BufferSize, const CLUINT32  TimeOut );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL
clpWriteRegister(ISerial *pSerial, const CLUINT32 Cookie, const CLINT64 Address, const CLINT8* pBuffer, const CLINT64 BufferSize, const CLUINT32  TimeOut );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL
clpContinueWriteRegister(ISerial *pSerial, const CLUINT32 Cookie, const BOOL8 ContinueWaiting, const CLUINT32  TimeOut );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpGetErrorText( CLINT32 errorCode, CLINT8* errorText, CLUINT32* errorTextSize, const CLUINT32 Cookie = 0);

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpDisconnect( const CLUINT32 Cookie );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpGetCLProtocolVersion( CLUINT32 *pVersionMajor, CLUINT32 *pVersionMinor );

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpGetParam( ISerial *pSerial, CLP_PARAMS param, const CLUINT32 Cookie, CLINT8* pBuffer, const CLINT64 BufferSize, const CLUINT32  TimeOut);

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpSetParam( ISerial *pSerial, CLP_PARAMS param, const CLUINT32 Cookie, const CLINT8* pBuffer, const CLINT64 BufferSize, const CLUINT32  TimeOut);

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL 
clpIsParamSupported( CLP_PARAMS param);

CLPROTOCOLEXPORT CLINT32 CLPROTOCOL
clpGetEventData(const CLUINT32 Cookie, CLINT8* pBuffer, CLUINT32* pBufferSize);
 // CLProtocolInterface // PublicInterfaces



#endif // CLPROTOCOL_CLPROTOCOL_H