src/LinuxAbstraction/LinuxAbstraction.cpp File Reference

Implementation file containing OS-specific functions (Linux) More...

#include <OSAbstraction.h>
#include <time.h>
#include <string.h>
#include <strings.h>
#include <stdio.h>
#include <stdlib.h>
#include <termios.h>
#include <unistd.h>

Go to the source code of this file.

Enumerations
enum	{ RESET, RAW }
Functions
int	DisableSingleCharacterInput (void)
int	EnableSingleCharacterInput (void)
void	delay (const int &TimeInMilliseconds)
int	stricmp (const char *s1, const char *s2)
unsigned char	WaitForKBCharacter (bool *Abort)
	Waits for one single keyboard stroke.
unsigned char	CheckForKBCharacter (void)
	Checks for one single keyboard stroke.
float	GetSystemTimeInSeconds (const bool &Reset)
	Returns a time value in seconds.
Variables
static struct termios termattr	save_termattr
static int	ttysavefd = -1
static bool	GetSystemTimeInSecondsCalledFirstTime = true
struct timespec	StoredSystemTimeInSeconds
static enum { ... }	ttystate

---

Detailed Description

Implementation file containing OS-specific functions (Linux)

GNU Public License
This file is part of the Fast Research Interface Library.

The Fast Research Interface Library is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Fast Research Interface Library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the Fast Research Interface Library. If not, see http://www.gnu.org/licenses/.

Stanford University
Department of Computer Science
Artificial Intelligence Laboratory
Gates Computer Science Building 1A
353 Serra Mall
Stanford, CA 94305-9010
USA

http://cs.stanford.edu/groups/manips

Date:

November 2011

Version:

1.0

Author:

Torsten Kroeger, tkr@s.nosp@m.tanf.nosp@m.ord.e.nosp@m.du

Note:

Copyright (C) 2011 Stanford University.

Definition in file LinuxAbstraction.cpp.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

RESET
RAW

Definition at line 88 of file LinuxAbstraction.cpp.

---

Function Documentation

unsigned char char CheckForKBCharacter

(

void

)

Checks for one single keyboard stroke.

The function returns immediately.

Returns:

• Value of the pressed key
• 255 if no key was pressed

See also:

WaitForKBCharacter()

Definition at line 240 of file LinuxAbstraction.cpp.

void delay

(

const int &

TimeInMilliseconds

)

Definition at line 97 of file LinuxAbstraction.cpp.

int DisableSingleCharacterInput

(

void

)

---

Definition at line 160 of file LinuxAbstraction.cpp.

int EnableSingleCharacterInput

(

void

)

Definition at line 115 of file LinuxAbstraction.cpp.

float GetSystemTimeInSeconds

(

const bool &

Reset = false

)

Returns a time value in seconds.

Operating system independent function to return the value of the system time in seconds.

Parameters:

Reset

If this flag is set, the value of this system time will be set to zero.

Returns:

The value of the system time in seconds.

Definition at line 266 of file LinuxAbstraction.cpp.

int stricmp	(	const char *	s1,
		const char *	s2
	)

Definition at line 104 of file LinuxAbstraction.cpp.

unsigned char WaitForKBCharacter

(

bool *

Abort = NULL

)

Waits for one single keyboard stroke.

The function returns after the stroke or if Abort becomes set. If Abort is set at the call of the function, the function only checks once, if a key has been pressed.

Parameters:

Abort

Pointer to a boolean values, which lets the function terminate

Returns:

• Value of the pressed key
• 255 if no key was pressed

See also:

CheckForKBCharacter()

Definition at line 180 of file LinuxAbstraction.cpp.

---

Variable Documentation

bool GetSystemTimeInSecondsCalledFirstTime = true [static]

Definition at line 77 of file LinuxAbstraction.cpp.

struct termios termattr save_termattr [static]

Definition at line 72 of file LinuxAbstraction.cpp.

struct timespec StoredSystemTimeInSeconds

Definition at line 79 of file LinuxAbstraction.cpp.

int ttysavefd = -1 [static]

Definition at line 75 of file LinuxAbstraction.cpp.

enum { ... } ttystate [static]