STCanScan.h

Go to the documentation of this file.

#ifndef CCANSTSCAN_H_
#define CCANSTSCAN_H_

#include "tchar.h"
#include "Winsock2.h"
#include "windows.h"
#include <string>
#include "CanStatistics.h"
#include "usbcan32.h"
#include "CCanAccess.h"

using namespace CanModule;

/*
 * This is an implementation of the abstract class CCanAccess. It serves as a can bus access layer that will communicate with Systec crates (Windows only)
 */
class STCanScan: public CanModule::CCanAccess
{
public:
        //Constructor of the class. Will initiate the statistics.
        STCanScan();
        //Disables copy constructor
        STCanScan(STCanScan const & other) = delete;
        //Disables asignation
        STCanScan& operator=(STCanScan const & other) = delete;
        //Destructor of the class
        virtual ~STCanScan();

        virtual bool createBus(const string name ,const string parameters);

    virtual bool sendMessage(short cobID, unsigned char len, unsigned char *message, bool rtr = false);

    /*
         * Method that sends a remote request trough the can bus channel. If the method createBUS was not called before this, sendMessage will fail, as there is no
         * can bus channel to send the request trough. Similar to sendMessage, but it sends an special message reserved for requests.
         * @param cobID: Identifier that will be used for the request.
         * @return: Was the initialisation process successful?
         */
        virtual bool sendRemoteRequest(short cobID);
        //Returns the instance of the CanStatistics object
        virtual void getStatistics( CanStatistics & result );

        Log::LogComponentHandle logItHandle(){ return m_logItHandleSt; }

private:

        //The number of the can module associated with this instance.
        int m_moduleNumber;
        //The number of the can channel associated with this instance.
        int m_channelNumber;
        //The number of can handle associated with this instance.
        int m_canHandleNumber;
        //Instance of the can handle
        tUcanHandle m_UcanHandle;
        //Instance of Can Statistics
        CanStatistics m_statistics;
        //Current baud rate
        unsigned int m_baudRate;

        Log::LogComponentHandle m_logItHandleSt;

        bool sendErrorCode(long);

        DWORD   m_busStatus;
        bool m_CanScanThreadShutdownFlag;
    // Handle for the CAN update scan manager thread.
    HANDLE      m_hCanScanThread;
    // Thread ID for the CAN update scan manager thread.
    DWORD   m_idCanScanThread;
    // The main control thread function for the CAN update scan manager.
        static DWORD WINAPI CanScanControlThread(LPVOID pCanScan);

        int configureCanBoard(const string name,const string parameters);
        int openCanPort(tUcanInitCanParam initializationParameters);
        /*
         * Provides textual representation of an error code.
         */
        bool errorCodeToString(long error, char message[]);
        static void setCanHandleInUse(int n,bool t) { s_isCanHandleInUseArray[n] = t; }
        static bool isCanHandleInUse(int n) { return s_isCanHandleInUseArray[n]; }
        static void setCanHandle(int n,tUcanHandle tU) { s_canHandleArray[n] = tU; }
        static tUcanHandle getCanHandle(int n) { return s_canHandleArray[n]; }

        static tUcanHandle s_canHandleArray[256];
        static bool s_isCanHandleInUseArray[256];


};

#endif