CPlatform Class Reference

Operation system depending functions. More...

#include <platform.h>

List of all members.

Static Public Member Functions
static void	sleep (unsigned long ms)
	Suspends current thread for ms milliseconds.
static unsigned long	getTickCount ()
	Returns time in milliseconds since system start.
static void	initThreads (bool rtc)
	Configures and starts all threads.
static void	mutex_lock (int id)
	Locks the mutex with id,.
static void	mutex_unlock (int id)
	Unlocks the mutex with id,.
static void	closeThreads ()
	Ends all threads.
static void	init ()
	Intializes mutexes, ...
static void	clean ()
	Deinitialisation.
static void	clearScreen ()
	Clears the console screen.
static bool	initSerial (char *cPort)
	Inits serial port.
static void	clearLine ()
	Clears the serial line buffer.
static void	readFromFile (char *filename, byte *buffer, int &len)
	Reads data from a file.
static void	writeToFile (char *filename, byte *buffer, int len)
	Writes data to a file.
static void	openMemoryMappedFile ()
	Opens shared memory in order to communicate with the opengl-viewer.
static void	closeMemoryMappedFile ()
	Close shared memory.
static void	writeToMemoryMappedFile (CRobot *robot)
	Writes 3d information of current robot pose to shared memory which will be visualized in the opengl-viewer.
static bool	TxD8 (byte bTxdData)
	Writes one byte to the serial line.
static byte	RxD8 (bool *failure=NULL)
	Reads one byte from the serial line.
static bool	RxD8Buffer (byte *buffer, int len)
	Reads len bytes from the serial line.
static bool	TxD8Buffer (byte *buffer, int len)
	Writes len bytes to the serial line.

---

Detailed Description

Operation system depending functions.

Functions:

• Time
• Thread control
• Shared Memory
• Console
• Serial Communication
• File Handling

---

Member Function Documentation

void CPlatform::sleep

(

unsigned long

ms

)

[static]

Suspends current thread for ms milliseconds.

unsigned long CPlatform::getTickCount

(

)

[static]

Returns time in milliseconds since system start.

void CPlatform::initThreads

(

bool

rtc

)

[static]

Configures and starts all threads.

void CPlatform::mutex_lock

(

int

id

)

[static]

Locks the mutex with id,.

See also:

MUTEX_IDENTIFIERS

void CPlatform::mutex_unlock

(

int

id

)

[static]

Unlocks the mutex with id,.

See also:

MUTEX_IDENTIFIERS

void CPlatform::closeThreads

(

)

[static]

Ends all threads.

void CPlatform::init

(

)

[static]

Intializes mutexes, ...

void CPlatform::clean

(

)

[static]

Deinitialisation.

void CPlatform::clearScreen

(

)

[static]

Clears the console screen.

bool CPlatform::initSerial

(

char *

cPort

)

[static]

Inits serial port.

void CPlatform::clearLine

(

)

[static]

Clears the serial line buffer.

void CPlatform::readFromFile	(	char *	filename,
		byte *	buffer,
		int &	len
	)			[static]

Reads data from a file.

void CPlatform::writeToFile	(	char *	filename,
		byte *	buffer,
		int	len
	)			[static]

Writes data to a file.

void CPlatform::openMemoryMappedFile

(

)

[static]

Opens shared memory in order to communicate with the opengl-viewer.

void CPlatform::closeMemoryMappedFile

(

)

[static]

Close shared memory.

void CPlatform::writeToMemoryMappedFile

(

CRobot *

robot

)

[static]

Writes 3d information of current robot pose to shared memory which will be visualized in the opengl-viewer.

bool CPlatform::TxD8

(

byte

bTxdData

)

[static]

Writes one byte to the serial line.

byte CPlatform::RxD8

(

bool *

failure = NULL

)

[static]

Reads one byte from the serial line.

bool CPlatform::RxD8Buffer	(	byte *	buffer,
		int	len
	)			[static]

Reads len bytes from the serial line.

bool CPlatform::TxD8Buffer	(	byte *	buffer,
		int	len
	)			[static]

Writes len bytes to the serial line.

---

The documentation for this class was generated from the following files:

• include/platform.h
• src/platform.cpp

---