Hauptseite | Klassenhierarchie | Alphabetische Liste | Auflistung der Klassen | Auflistung der Dateien | Klassen-Elemente

CTCPIPConnector Klassenreferenz

low level routine for fps - connector Mehr...

#include <tcpipconnector.hpp>

Klassendiagramm für CTCPIPConnector:

CTCPIPComm CTCPIPCommReceive CTCPIPCommSend CTCPIPCommConnect CTraceObject CTraceObject CTraceObject Cfps Aufstellung aller Elemente

Öffentliche Methoden

 CTCPIPConnector ()
 initalize mutex for send_data this ensures that only a data block will be sent at one time

virtual ~CTCPIPConnector ()
 frees the mutex handle for send data

virtual bool initialize (const short TCPport, const char *pIPAddress)
 initialize connection to the gateway

bool ReadEepromData (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a read eeprom request

bool SendReadEepromDataCnf (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a read eeprom confirmation

bool ReadProgramData (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a read program memory request

bool SendReadProgramDataCnf (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a read program confirmation

bool ReadRamData (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a read ram request

bool SendReadRamDataCnf (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a read ram confirmation

bool WriteEepromData (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a write eeprom request

bool SendWriteEepromDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a write eeprom confirmation

bool WriteProgramData (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a write program memory request

bool SendWriteProgramDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a write program memory confirmation

bool WriteRamData (ADDRESS_TYPE nAddress, const std::vector< unsigned char > &aucData)
 send a write ram request

bool SendWriteRamDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)
 send a write ram confirmation

bool SendStatusInfo (ADDRESS_TYPE nAddress, unsigned int uiLength, std::vector< unsigned char > aucData)
 send a status information command

bool terminate (void)
 close the current connection

CCOMConnector * GetCOMPort (void) const
 get access to the associated COM port

void SetCOMPort (CCOMConnector *pMsg)
 Set associated COM port parameters.

bool IsConnected (void) const
 IsConnected returns the connection state of the connection.


Geschützte Methoden

void Receive (void *pData, long DataLen)
 implemented pure virtual function from CTCPIPReceive

virtual void ReadEepromDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a read eeprom request was received

virtual void ReadProgramDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a read program request was received

virtual void ReadRamDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a read ram request was received

virtual void WriteEepromDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a write eeprom request was received

virtual void WriteProgramDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a write program request was received

virtual void WriteRamDataReq (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a write ram request was received

virtual void ReadEepromDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a read eeprom confirmation was received

virtual void ReadProgramDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a read program confirmation was received

virtual void ReadRamDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a read ram confirmation was received

virtual void WriteEepromDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a write eeprom confirmation was received

virtual void WriteProgramDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a write program confirmation was received

virtual void WriteRamDataCnf (ADDRESS_TYPE nAddress, unsigned int uiLength)=0
 this function will be called if a write ram confirmation was received

virtual void StatusInfo (ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)=0
 this function will be called if a status information was received

void SetUseCrcCheck (const bool bUseCrc)
 set use of crc check while receiving data

bool GetUseCrcCheck (void) const
 Gives the crc check flag back.


Geschützte Attribute

bool m_bRcvRawData
bool m_bRcvRawDataFinished
char m_sRcvRawDataString [200]

Private Methoden

void CallMessageFunc (const CCommandstring &oCommandstring)
 call the function corresponding to the overgiven commasn block

bool send_data (CCommandstring::CmdCode Command, ADDRESS_TYPE nAddress, unsigned int uiLength, const std::vector< unsigned char > &aucData)
 sends the overgiven command to the fps


Private Attribute

CStatemaschine m_oStatemaschine
 statemaschine to handle command blocks

std::vector< unsigned char > m_aucReceivedData
 received data

HANDLE m_hSendBlock
 Mutex. Lock to ensure that only one command string will be send at a time.

bool m_bUseCrcCheck
 flag : true = use crc check while receiving data

CCOMConnector * m_pCOMPort
 use a direct COM port connection for FPS access

Ausführliche Beschreibung

low level routine for fps - connector

Zu beachten:
you have to write a class inheriting these class. In the new class you must implement the following pure virtual functions :

virtual void ReadEepromDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void ReadProgramDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void ReadRamDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void WriteEepromDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void WriteProgramDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void WriteRamDataReq( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void ReadEepromDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void ReadProgramDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void ReadRamDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

virtual void WriteEepromDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void WriteProgramDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void WriteRamDataCnf( ADDRESS_TYPE nAddress,
unsigned int uiLength )= 0;

virtual void StatusInfo( ADDRESS_TYPE nAddress,
unsigned int uiLength,
const std::vector<unsigned char>& aucData )= 0;

These functions will be called if a appriviate command block is received

Version:
1.0
Autor:
Ingo Fröhlich

Dokumentation der Elementfunktionen

void CTCPIPConnector::CallMessageFunc (  const CCommandstring &  oCommandstring  )  [private]
 

call the function corresponding to the overgiven commasn block

Parameter:
command string
Rückgabe:
---

CCOMConnector* CTCPIPConnector::GetCOMPort (  void   )  const [inline]
 

get access to the associated COM port

Parameter:
--- 
Rückgabe:
pointer to COM port class (is NULL, if communication via TCP/Modem)

bool CTCPIPConnector::GetUseCrcCheck (  void   )  const [protected]
 

Gives the crc check flag back.

Rückgabe:
true: use crc check

bool CTCPIPConnector::initialize (  const short  TCPport,
const char *  pIPAddress
)  [virtual]
 

initialize connection to the gateway

Parameter:
portnumber 
ip-address 
Rückgabe:
true connection established

bool CTCPIPConnector::IsConnected (  void   )  const
 

IsConnected returns the connection state of the connection.

Parameter:
- 
Rückgabe:
true if connection established, otherwise false

Erneute Implementation von CTCPIPComm.

bool CTCPIPConnector::ReadEepromData (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a read eeprom request

use this function to read data from the eeprom of the fps

Zu beachten:
use WaitForData to wait for the confirmation with the wanted data
Parameter:
address to start reading
number of bytes to read
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::ReadEepromDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a read eeprom confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::ReadEepromDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a read eeprom request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

bool CTCPIPConnector::ReadProgramData (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a read program memory request

use this function to read data from the program memory of the fps

Zu beachten:
use WaitForData to wait for the confirmation with the wanted data
Parameter:
address to start reading
number of bytes to read
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::ReadProgramDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a read program confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::ReadProgramDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a read program request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

bool CTCPIPConnector::ReadRamData (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a read ram request

use this function to read data from the ram of the fps

Zu beachten:
use WaitForData to wait for the confirmation with the wanted data
Parameter:
address to start reading
number of bytes to read
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::ReadRamDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a read ram confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::ReadRamDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a read ram request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

void CTCPIPConnector::Receive (  void *  pData,
long  DataLen
)  [protected, virtual]
 

implemented pure virtual function from CTCPIPReceive

Parameter:
pointer to buffer to store received data in
length ( in bytes ) of the buffer
Rückgabe:
---

Implementiert CTCPIPCommReceive.

bool CTCPIPConnector::send_data (  CCommandstring::CmdCode  Command,
ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [private]
 

sends the overgiven command to the fps

Parameter:
command code of the command to send
address in fps
length of the data to be readed or written
the data
Rückgabe:
true data was sent correctly

bool CTCPIPConnector::SendReadEepromDataCnf (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a read eeprom confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
readed data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendReadProgramDataCnf (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a read program confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
readed data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendReadRamDataCnf (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a read ram confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
readed data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendStatusInfo (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
std::vector< unsigned char >  aucData
) 
 

send a status information command

Zu beachten:
use this function to simulate the reaction of a fps device. These command will be sent by a fps device during startup and in case of an error
Parameter:
confirmed address
length of "written" data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendWriteEepromDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a write eeprom confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
length of "written" data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendWriteProgramDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a write program memory confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
length of "written" data
Rückgabe:
true request was sent successfully

bool CTCPIPConnector::SendWriteRamDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
) 
 

send a write ram confirmation

Zu beachten:
use this function to simulate the reaction of a fps device
Parameter:
confirmed address
length of "written" data
Rückgabe:
true request was sent successfully

void CTCPIPConnector::SetCOMPort (  CCOMConnector *  pMsg  )  [inline]
 

Set associated COM port parameters.

Use this if not the standard communication via TCP/Modem is to be used. Uses a direct communictaion via serial port.

Parameter:
pointer to COM port class or NULL for TCP/Modem communication
Rückgabe:
---

void CTCPIPConnector::SetUseCrcCheck (  const bool  bUseCrc  )  [protected]
 

set use of crc check while receiving data

Parameter:
true : use crc check
Rückgabe:
---

virtual void CTCPIPConnector::StatusInfo (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a status information was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

bool CTCPIPConnector::terminate (  void   ) 
 

close the current connection

Parameter:
--- 
Rückgabe:
true operation was successfull

bool CTCPIPConnector::WriteEepromData (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a write eeprom request

use this function to write data to the eeprom of the fps

Zu beachten:
use WaitForData to wait for the confirmation
Parameter:
address to start writing
number of bytes to write
data to write
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::WriteEepromDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a write eeprom confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::WriteEepromDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a write eeprom request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

bool CTCPIPConnector::WriteProgramData (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a write program memory request

use this function to write data to the program memory of the fps

Zu beachten:
use WaitForData to wait for the confirmation
Parameter:
address to start writing
number of bytes to write
data to write
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::WriteProgramDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a write program confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::WriteProgramDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a write program request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

bool CTCPIPConnector::WriteRamData (  ADDRESS_TYPE  nAddress,
const std::vector< unsigned char > &  aucData
) 
 

send a write ram request

use this function to write data to the ram of the fps

Zu beachten:
use WaitForData to wait for the confirmation
Parameter:
address to start writing
number of bytes to write
data to write
Rückgabe:
true request was sent successfully

virtual void CTCPIPConnector::WriteRamDataCnf (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength
)  [protected, pure virtual]
 

this function will be called if a write ram confirmation was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
Rückgabe:
---

Implementiert in Cfps.

virtual void CTCPIPConnector::WriteRamDataReq (  ADDRESS_TYPE  nAddress,
unsigned int  uiLength,
const std::vector< unsigned char > &  aucData
)  [protected, pure virtual]
 

this function will be called if a write ram request was received

Zu beachten:
because this is a pure virtual function you have to implement the function by yourself
Parameter:
received address
received data length
received data
Rückgabe:
---

Implementiert in Cfps.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:
Erzeugt am Tue Mar 11 14:25:05 2008 für SchunkFPS von doxygen 1.3.7