Fast Research Interface Library  Manual and Documentation
Defines | Functions
include/OSAbstraction.h File Reference

Header file for simple OS-specific functions for abstraction. More...

#include <stdlib.h>

Go to the source code of this file.

Defines

#define OS_FOLDER_SEPARATOR   ("/")
 Slash for non-Microsoft operating system or backslash for Microsoft operating systems.

Functions

unsigned char WaitForKBCharacter (bool *Abort=NULL)
 Waits for one single keyboard stroke.
unsigned char CheckForKBCharacter (void)
 Checks for one single keyboard stroke.
float GetSystemTimeInSeconds (const bool &Reset=false)
 Returns a time value in seconds.

Detailed Description

Header file for simple OS-specific functions for abstraction.



GNU Lesser 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

Definition in file OSAbstraction.h.


Define Documentation

#define OS_FOLDER_SEPARATOR   ("/")

Slash for non-Microsoft operating system or backslash for Microsoft operating systems.

Definition at line 69 of file OSAbstraction.h.


Function Documentation

unsigned 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.

float GetSystemTimeInSeconds ( const bool &  Reset)

Returns a time value in seconds.

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

Parameters:
ResetIf 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.

unsigned char WaitForKBCharacter ( bool *  Abort)

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:
AbortPointer 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.

This document was generated with Doxygen on Thu Apr 12 2012 11:18:54. User documentation of the Fast Research Interface Library for the KUKA Lightweight Robot IV by the Stanford Robotics Research Group. Copyright 2010–2012.