The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::SystemPeer Class Reference

Defines the SystemPeer interface. More...

#include <vcf/FoundationKit/SystemPeer.h>

Inheritance diagram for VCF::SystemPeer:

List of all members.

Public Member Functions
virtual	~SystemPeer ()
virtual uint32	getTickCount ()=0
	tries to return a uint32 representing the current tick count of the system
virtual void	sleep (const uint32 &milliseconds)=0
	causes the calling thread to pause for the specified number of milliseconds
virtual bool	doesFileExist (const String &fileName)=0
virtual String	getEnvironmentVariable (const String &variableName)=0
virtual void	setEnvironmentVariable (const String &variableName, const String &newValue)=0
virtual void	addPathDirectory (const String &directory)=0
virtual String	getCurrentWorkingDirectory ()=0
virtual void	setCurrentWorkingDirectory (const String &currentDirectory)=0
virtual String	getCommonDirectory (System::CommonDirectory directory)=0
virtual String	createTempFileName (const String &directory)=0
virtual void	setDateToSystemTime (DateTime *date)=0
virtual void	setDateToLocalTime (DateTime *date)=0
virtual void	setCurrentThreadLocale (Locale *locale)=0
virtual bool	isUnicodeEnabled ()=0
virtual DateTime	convertUTCTimeToLocalTime (const DateTime &date)=0
virtual DateTime	convertLocalTimeToUTCTime (const DateTime &date)=0
virtual void	setTimeZoneToLocal (const DateTime &currentDate, TimeZone &tz)=0
virtual String	getOSName ()=0
virtual String	getOSVersion ()=0
virtual String	getComputerName ()=0
virtual String	getUserName ()=0
virtual ProgramInfo *	getProgramInfoFromFileName (const String &fileName)=0

---

Detailed Description

Defines the SystemPeer interface.

---

Constructor & Destructor Documentation

virtual VCF::SystemPeer::~SystemPeer (   )  [inline, virtual]

---

Member Function Documentation

virtual void VCF::SystemPeer::addPathDirectory (  const String &  directory  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual DateTime VCF::SystemPeer::convertLocalTimeToUTCTime (  const DateTime &  date  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual DateTime VCF::SystemPeer::convertUTCTimeToLocalTime (  const DateTime &  date  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::createTempFileName (  const String &  directory  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual bool VCF::SystemPeer::doesFileExist (  const String &  fileName  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getCommonDirectory (  System::CommonDirectory  directory  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getComputerName (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getCurrentWorkingDirectory (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getEnvironmentVariable (  const String &  variableName  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getOSName (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getOSVersion (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual ProgramInfo* VCF::SystemPeer::getProgramInfoFromFileName (  const String &  fileName  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual uint32 VCF::SystemPeer::getTickCount (   )  [pure virtual]

tries to return a uint32 representing the current tick count of the system Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual String VCF::SystemPeer::getUserName (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual bool VCF::SystemPeer::isUnicodeEnabled (   )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setCurrentThreadLocale (  Locale *  locale  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setCurrentWorkingDirectory (  const String &  currentDirectory  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setDateToLocalTime (  DateTime *  date  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setDateToSystemTime (  DateTime *  date  )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setEnvironmentVariable (  const String &  variableName, const String &  newValue )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::setTimeZoneToLocal (  const DateTime &  currentDate, TimeZone &  tz )  [pure virtual]

Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

virtual void VCF::SystemPeer::sleep (  const uint32 &  milliseconds  )  [pure virtual]

causes the calling thread to pause for the specified number of milliseconds Parameters: uint32  the number of milliseconds to pause the thread Implemented in VCF::LinuxSystemPeer, VCF::OSXSystemPeer, and VCF::Win32SystemPeer.

---

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

• vcf/FoundationKit/SystemPeer.h

Comments or Suggestions?    License Information