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

# CRcvBuffer Klassenreferenz

handles the received data Mehr...

Aufstellung aller Elemente

## Öffentliche Methoden
| CRcvBuffer ()
| CRcvBuffer (const CRcvBuffer &OldObject)
virtual | ~CRcvBuffer ()
CRcvBuffer & | operator= (const CRcvBuffer &NewObject)
DWORD | GetTimeOut (void) const
| get/ set timeouts
void | SetTimeOut (const DWORD dwNewTimeOut)
RECEIVED_TYPE | GetCommand (void) const
| get / set received command
void | SetCommand (RECEIVED_TYPE NewCommand)
ADDRESS_TYPE | GetAddress (void) const
| get/ set buffer
unsigned int | GetLength (void) const
std::vector< unsigned char > | GetData (void) const
void | SetAddress (const ADDRESS_TYPE nAddress)
void | SetLength (const unsigned int uiLength)
void | SetData (const std::vector< unsigned char > &aucData)
bool | BeginDataTransfer (void) const
| (un)locking rcvbuffer
bool | EndDataTransfer (void) const
bool | StoreData (const RECEIVED_TYPE Command, const ADDRESS_TYPE nAddress, const unsigned int uiLength, const std::vector< unsigned char > &aucData=std::vector< unsigned char >::vector())
| store the data into rcvbuffer
bool | FetchData (RECEIVED_TYPE &Command, ADDRESS_TYPE &nAddress, unsigned int &uiLength, std::vector< unsigned char > &aucData)
| CRcvBuffer ()
| constructor creates mutex to protect internal buffer
| CRcvBuffer (const CRcvBuffer &OldObject)
| copyconstructor needed because we create a mutex during the constructor
virtual | ~CRcvBuffer ()
| destructor frees mutex
CRcvBuffer & | operator= (const CRcvBuffer &NewObject)
| overwrite assignment operator needed because we create a mutex during the constructor
DWORD | GetTimeOut (void) const
| delivers current internal timeout value
void | SetTimeOut (const DWORD dwNewTimeOut)
| sets current internal timeout value
RECEIVED_TYPE | GetCommand (void) const
| delivers received command
void | SetCommand (RECEIVED_TYPE NewCommand)
| sets received command
ADDRESS_TYPE | GetAddress (void) const
| delivers received address
unsigned int | GetLength (void) const
| delivers received data length
std::vector< unsigned char > | GetData (void) const
| delivers received data
void | SetAddress (const ADDRESS_TYPE nAddress)
| sets received command
void | SetLength (const unsigned int uiLength)
| sets received data length
void | SetData (const std::vector< unsigned char > &aucData)
| sets received data
bool | BeginDataTransfer (void) const
| locking receive buffer
bool | EndDataTransfer (void) const
| unlock receive buffer
bool | StoreData (const RECEIVED_TYPE Command, const ADDRESS_TYPE nAddress, const unsigned int uiLength, const std::vector< unsigned char > &aucData=std::vector< unsigned char >::vector())
| store the data into rcvbuffer
bool | FetchData (RECEIVED_TYPE &Command, ADDRESS_TYPE &nAddress, unsigned int &uiLength, std::vector< unsigned char > &aucData)
| delivers the received data

## Ausführliche Beschreibung

Version:
  1.0

Autor:
  Ingo Fröhlich

## Beschreibung der Konstruktoren und Destruktoren

CRcvBuffer::CRcvBuffer | ( |  | ) |

CRcvBuffer::CRcvBuffer | ( | const CRcvBuffer & | OldObject | ) |

virtual CRcvBuffer::~CRcvBuffer | ( |  | ) | `[virtual]`

CRcvBuffer::CRcvBuffer | ( |  | ) |

CRcvBuffer::CRcvBuffer | ( | const CRcvBuffer & | OldObject | ) |

virtual CRcvBuffer::~CRcvBuffer | ( |  | ) | `[virtual]`

## Dokumentation der Elementfunktionen

bool CRcvBuffer::BeginDataTransfer | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: true lock successfull false else

bool CRcvBuffer::BeginDataTransfer | ( | void |  | ) | const

bool CRcvBuffer::EndDataTransfer | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: true unlock successfull false else

bool CRcvBuffer::EndDataTransfer | ( | void |  | ) | const

bool CRcvBuffer::FetchData | ( | RECEIVED_TYPE & | Command,
|  | ADDRESS_TYPE & | nAddress,
|  | unsigned int & | uiLength,
|  | std::vector< unsigned char > & | aucData
| ) |

  | Parameter:
  | returned | received command
  | returned | received address
  | returned | received data length
  | returned | received data
Rückgabe: true operation successfull false else

bool CRcvBuffer::FetchData | ( | RECEIVED_TYPE & | Command,
|  | ADDRESS_TYPE & | nAddress,
|  | unsigned int & | uiLength,
|  | std::vector< unsigned char > & | aucData
| ) |

ADDRESS_TYPE CRcvBuffer::GetAddress | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: received address

ADDRESS_TYPE CRcvBuffer::GetAddress | ( | void |  | ) | const

RECEIVED_TYPE CRcvBuffer::GetCommand | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: received command

RECEIVED_TYPE CRcvBuffer::GetCommand | ( | void |  | ) | const

std::vector<unsigned char> CRcvBuffer::GetData | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: vector with received data

std::vector<unsigned char> CRcvBuffer::GetData | ( | void |  | ) | const

unsigned int CRcvBuffer::GetLength | ( | void |  | ) | const

  | Parameter:
  | --- |
Rückgabe: received length

unsigned int CRcvBuffer::GetLength | ( | void |  | ) | const

DWORD CRcvBuffer::GetTimeOut | ( | void |  | ) | const

  | uses during receiving data from the receive thread Parameter:
  | --- |
Rückgabe: current timeout

DWORD CRcvBuffer::GetTimeOut | ( | void |  | ) | const

CRcvBuffer& CRcvBuffer::operator= | ( | const CRcvBuffer & | NewObject | ) |

CRcvBuffer& CRcvBuffer::operator= | ( | const CRcvBuffer & | NewObject | ) |

void CRcvBuffer::SetAddress | ( | const ADDRESS_TYPE | nAddress | ) |

  | Parameter:
  | command |
Rückgabe: ---

void CRcvBuffer::SetAddress | ( | const ADDRESS_TYPE | nAddress | ) |

void CRcvBuffer::SetCommand | ( | RECEIVED_TYPE | NewCommand | ) |

  | Parameter:
  | received | command
Rückgabe: ---

void CRcvBuffer::SetCommand | ( | RECEIVED_TYPE | NewCommand | ) |

void CRcvBuffer::SetData | ( | const std::vector< unsigned char > & | aucData | ) |

  | Parameter:
  | received | data
Rückgabe: ---

void CRcvBuffer::SetData | ( | const std::vector< unsigned char > & | aucData | ) |

void CRcvBuffer::SetLength | ( | const unsigned int | uiLength | ) |

  | Parameter:
  | data | length
Rückgabe: ---

void CRcvBuffer::SetLength | ( | const unsigned int | uiLength | ) |

void CRcvBuffer::SetTimeOut | ( | const DWORD | dwNewTimeOut | ) |

  | uses during receiving data from the receive thread Parameter:
  | new | internal timeout value
Rückgabe: ---

void CRcvBuffer::SetTimeOut | ( | const DWORD | dwNewTimeOut | ) |

bool CRcvBuffer::StoreData | ( | const RECEIVED_TYPE | Command,
|  | const ADDRESS_TYPE | nAddress,
|  | const unsigned int | uiLength,
|  | const std::vector< unsigned char > & | aucData = `std::vector< unsigned char >::vector()`
| ) |

  | Parameter:
  | command |
  | address |
  | length | of the data
  | the | data
Rückgabe: true store successfull false else

bool CRcvBuffer::StoreData | ( | const RECEIVED_TYPE | Command,
|  | const ADDRESS_TYPE | nAddress,
|  | const unsigned int | uiLength,
|  | const std::vector< unsigned char > & | aucData = `std::vector< unsigned char >::vector()`
| ) |

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

- fps_rcvbuffer.hpp
- rcvbuffer.hpp