LOW_platformMisc_Linux Class Reference

Platform specific miscelanious for Linux platforms. More...

#include <LOW_platformMisc_Linux.h>

Inheritance diagram for LOW_platformMisc_Linux:

[legend]Collaboration diagram for LOW_platformMisc_Linux:

[legend]List of all members.


Public Types
typedef LOW_platformMisc::timestamp_t	timestamp_t
	Data structure for timestamps.
Public Member Functions
virtual	~LOW_platformMisc_Linux ()
	Destructor.
void const	p_secSleep (const unsigned int inSeconds) const
	Sleep for a specified number of seconds.
void const	p_milliSleep (const unsigned long inMilliSeconds) const
	Sleep for a specified number of milli seconds.
void const	p_microSleep (const unsigned long inMicroSeconds) const
	Sleep for a specified number of micro seconds.
void const	p_nanoSleep (const unsigned long inNanoSeconds) const
	Sleep for a specified number of nano seconds.
void const	p_nanoSleep (const unsigned int inSeconds, const unsigned long inNanoSeconds) const
	Sleep for a specified number of nano seconds.
void const	p_getTimestamp (LOW_platformMisc::timestamp_t &outTimestamp) const
LOW_platformMiscFactory::threadIdent_t const	p_getThreadID () const
	Get identifier for current thread.
std::string const	p_getHostname () const
	Get the host's name.
	class_DERIVE_FROM_EXCEPTION (platformMisc_error, LOW_exception)
	Exception base class for all exceptions thrown by LOW_platformMisc.
Static Public Member Functions
const void	secSleep (const unsigned int inSeconds)
	Sleep for a specified number of seconds.
const void	milliSleep (const unsigned long inMilliSeconds)
	Sleep for a specified number of milli seconds.
const void	microSleep (const unsigned long inMicroSeconds)
	Sleep for a specified number of micro seconds.
const void	nanoSleep (const unsigned long inNanoSeconds)
	Sleep for a specified number of nano seconds.
const void	nanoSleep (const unsigned int inSeconds, const unsigned long inNanoSeconds)
	Sleep for a specified number of nano seconds.
const void	getTimestamp (timestamp_t &outTimestamp)
	Get a timestamp.
const void	diffTimestamp (const timestamp_t &inT1, const timestamp_t &inT2, timestamp_t &outResult)
	Calculate difference of two timestamps.
const LOW_platformMiscFactory::threadIdent_t	getThreadID ()
	Get identifier for current thread.
const std::string	getHostname ()
	Get the host's name.
Protected Member Functions
	LOW_platformMisc_Linux ()
	Constructor.
virtual const void	p_getTimestamp (timestamp_t &outTimestamp) const=0
	Get a timestamp.
Friends
class	LOW_platformMiscFactory
	To allow construction.

Detailed Description

Platform specific miscelanious for Linux platforms.

This class is thread-safe.

Author:: Harald Roelle

Definition at line 31 of file LOW_platformMisc_Linux.h.

Member Typedef Documentation

typedef struct LOW_platformMisc::timestamp_t LOW_platformMisc::timestamp_t [inherited]

Data structure for timestamps.

Constructor & Destructor Documentation

LOW_platformMisc_Linux::~LOW_platformMisc_Linux ( ) [virtual]

Destructor.

Definition at line 41 of file LOW_platformMisc_Linux.cpp.

LOW_platformMisc_Linux::LOW_platformMisc_Linux ( ) [protected]

Constructor.
Not publicly constructable. Use LOW_platformMiscFactory.
Definition at line 36 of file LOW_platformMisc_Linux.cpp.

Member Function Documentation

LOW_platformMisc::class_DERIVE_FROM_EXCEPTION ( platformMisc_error ,

LOW_exception

) [inherited]

Exception base class for all exceptions thrown by LOW_platformMisc.

const void LOW_platformMisc::diffTimestamp ( const timestamp_t & inT1,

const timestamp_t & inT2,

timestamp_t & outResult

) [static, inherited]

Calculate difference of two timestamps.

Parameters:

inT1 A timestamp.

inT2 A timestamp.

outResult T1-T2.

Definition at line 61 of file LOW_platformMisc.cpp.
References LOW_platformMisc::timestamp_t::milSec, and LOW_platformMisc::timestamp_t::sec.
Referenced by LOW_compJalousieController::measureTransitionDelays().

const std::string LOW_platformMisc::getHostname ( ) [static, inherited]

Get the host's name.

Returns:
Host's name.

Definition at line 83 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_getHostname(), and LOW_platformMisc::runtimeInstance.

const LOW_platformMiscFactory::threadIdent_t LOW_platformMisc::getThreadID ( ) [static, inherited]

Get identifier for current thread.

Returns:
Unique identifier for current thread.

Definition at line 77 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_getThreadID(), and LOW_platformMisc::runtimeInstance.
Referenced by LOW_objectSynchronizer::__synchronizeMethodReadWeak::__synchronizeMethodReadWeak(), LOW_objectSynchronizer::__synchronizeMethodWrite::__synchronizeMethodWrite(), LOW_objectSynchronizer::__synchronizeMethodWriteWeak::__synchronizeMethodWriteWeak(), LOW_objectSynchronizer::__synchronizeStaticReadWeak::__synchronizeStaticReadWeak(), LOW_objectSynchronizer::__synchronizeStaticWrite::__synchronizeStaticWrite(), LOW_objectSynchronizer::__synchronizeStaticWriteWeak::__synchronizeStaticWriteWeak(), and LOW_helper_msglog::fprintLogHeader().

const void LOW_platformMisc::getTimestamp ( timestamp_t & outTimestamp ) [static, inherited]

Get a timestamp.

Parameters:

outTimestamp Where timestamp should be written to.

Definition at line 55 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_getTimestamp(), and LOW_platformMisc::runtimeInstance.
Referenced by LOW_compJalousieController::measureTransitionDelays().

const void LOW_platformMisc::microSleep ( const unsigned long inMicroSeconds ) [static, inherited]

Sleep for a specified number of micro seconds.

Parameters:

inMicroSeconds Number of micro seconds to sleep.

Definition at line 37 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_microSleep(), and LOW_platformMisc::runtimeInstance.
Referenced by LOW_linkDS2490::programPulse(), and LOW_linkDS2480B::pulse_cmd_manual().

const void LOW_platformMisc::milliSleep ( const unsigned long inMilliSeconds ) [static, inherited]

Sleep for a specified number of milli seconds.

Parameters:

inMilliSeconds Number of milli seconds to sleep.

Definition at line 31 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_milliSleep(), and LOW_platformMisc::runtimeInstance.
Referenced by LOW_compJalousieController::moveDownStop(), LOW_compJalousieController::moveUpStop(), LOW_linkDS2480B::pulse_cmd_manual(), LOW_linkDS2480B::resetLinkAdapter(), LOW_linkDS2490::strongPullup(), and LOW_linkDS2490::waitUntilIdle().

const void LOW_platformMisc::nanoSleep ( const unsigned int inSeconds,

const unsigned long inNanoSeconds

) [static, inherited]

Sleep for a specified number of nano seconds.

Parameters:

inSeconds Number of seconds to sleep.

inNanoSeconds Number of additional nano seconds to sleep.

Definition at line 49 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_nanoSleep(), and LOW_platformMisc::runtimeInstance.

const void LOW_platformMisc::nanoSleep ( const unsigned long inNanoSeconds ) [static, inherited]

Sleep for a specified number of nano seconds.

Parameters:

inNanoSeconds Number of nano seconds to sleep.

Definition at line 43 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_nanoSleep(), and LOW_platformMisc::runtimeInstance.

const std::string LOW_platformMisc_Linux::p_getHostname ( ) const [virtual]

Get the host's name.
Virtual method to be implemented by OS specific subclasses.
Returns:
Host's name.

Implements LOW_platformMisc.
Definition at line 108 of file LOW_platformMisc_Linux.cpp.

const LOW_platformMiscFactory::threadIdent_t LOW_platformMisc_Linux::p_getThreadID ( ) const [virtual]

Get identifier for current thread.
Virtual method to be implemented by OS specific subclasses.
Returns:
Unique identifier for current thread.

Implements LOW_platformMisc.
Definition at line 102 of file LOW_platformMisc_Linux.cpp.

virtual const void LOW_platformMisc::p_getTimestamp ( timestamp_t & outTimestamp ) const [protected, pure virtual, inherited]

Get a timestamp.
Virtual method to be implemented by OS specific subclasses.
Parameters:

outTimestamp Where timestamp should written to.

Referenced by LOW_platformMisc::getTimestamp().

const void LOW_platformMisc_Linux::p_getTimestamp ( LOW_platformMisc::timestamp_t & outTimestamp ) const

Definition at line 93 of file LOW_platformMisc_Linux.cpp.
References LOW_platformMisc::timestamp_t::milSec, and LOW_platformMisc::timestamp_t::sec.

const void LOW_platformMisc_Linux::p_microSleep ( const unsigned long inMicroSeconds ) const [virtual]

Sleep for a specified number of micro seconds.
Virtual method to be implemented by OS specific subclasses.
Parameters:

inMicroSeconds Number of micro seconds to sleep.

Implements LOW_platformMisc.
Definition at line 65 of file LOW_platformMisc_Linux.cpp.
References p_nanoSleep().

const void LOW_platformMisc_Linux::p_milliSleep ( const unsigned long inMilliSeconds ) const [virtual]

Sleep for a specified number of milli seconds.
Virtual method to be implemented by OS specific subclasses.
Parameters:

inMilliSeconds Number of milli seconds to sleep.

Implements LOW_platformMisc.
Definition at line 57 of file LOW_platformMisc_Linux.cpp.
References p_nanoSleep().

const void LOW_platformMisc_Linux::p_nanoSleep ( const unsigned int inSeconds,

const unsigned long inNanoSeconds

) const [virtual]

Sleep for a specified number of nano seconds.
Virtual method to be implemented by OS specific subclasses.
Parameters:

inSeconds Number of seconds to sleep.

inNanoSeconds Number of additional nano seconds to sleep.

Implements LOW_platformMisc.
Definition at line 79 of file LOW_platformMisc_Linux.cpp.

const void LOW_platformMisc_Linux::p_nanoSleep ( const unsigned long inNanoSeconds ) const [virtual]

Sleep for a specified number of nano seconds.
Virtual method to be implemented by OS specific subclasses.
Parameters:

inNanoSeconds Number of nano seconds to sleep.

Implements LOW_platformMisc.
Definition at line 73 of file LOW_platformMisc_Linux.cpp.
Referenced by p_microSleep(), p_milliSleep(), and p_secSleep().

const void LOW_platformMisc_Linux::p_secSleep ( const unsigned int inSeconds ) const [virtual]

Sleep for a specified number of seconds.
Virtual method to be implemented by OS specific subclasses.
Parameters:

inSeconds Number of seconds to sleep.

Implements LOW_platformMisc.
Definition at line 51 of file LOW_platformMisc_Linux.cpp.
References p_nanoSleep().

const void LOW_platformMisc::secSleep ( const unsigned int inSeconds ) [static, inherited]

Sleep for a specified number of seconds.

Parameters:

inSeconds Number of seconds to sleep.

Definition at line 25 of file LOW_platformMisc.cpp.
References LOW_platformMisc::p_secSleep(), and LOW_platformMisc::runtimeInstance.
Referenced by LOW_linkPassiveSerial::strongPullup().

Friends And Related Function Documentation

friend class LOW_platformMiscFactory [friend]

To allow construction.

Definition at line 74 of file LOW_platformMisc_Linux.h.

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

Generated on Tue Feb 3 11:31:06 2004 for OneWireLibrary++ by

1.3.2

LOW_platformMisc_Linux Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation