User Manual, Developers Guide and API Documentation

wns Namespace Reference

Contains the core functionailty. More...


Classes

class  ArgumentFunctor
 The base class of the Functor with one argument. More...
class  Assure
 Pseudo class grouping the assure functionality. More...
struct  AtApplicationExit
struct  AtSimulatorExit
class  Average
 Computes the average of a number of samples. More...
class  wns::Average< double >
 Compute the average for double values. More...
class  AverageBase
 Base class to compute the average. More...
class  Backtrace
 Makes a snapshot of the current stack. More...
class  Birthmark
 Unique identifier. More...
class  Broker
 Able to create ELEMENTs from respective pyconfig::View. More...
class  Cache
 A template that supports caching. More...
class  CandI
 class to encapsulate carrier and interference power levels separately for SDMA purposes intra-cell interference can be given separately More...
class  Chamaeleon
 Helps to put objects of different type into one container. More...
class  ChamaeleonBase
 Base class for Chamaeleon<T>. More...
class  Class
 Helper class, that turns a POD into a class. More...
class  Cloneable
 Default implementation of CloneableInterface. More...
class  CloneableInterface
 Support to (polymorphically) clone objects. More...
class  CloneNotSupported
 Last resort: Throw this if your class is not cloneable. More...
class  const_smart_ptr_mem_fun_t
class  Converter
class  wns::Converter< std::string, FROM, true >
class  Creator
 Factory method interface to use as creator for StaticFactory. More...
class  wns::Creator< KIND, KIND >
struct  DefaultCreation
class  DerefLess
class  Direction
 Determin the direction from a PositionOffset. More...
class  DoubleDispatcher
 Multimethods for C++. More...
class  wns::DoubleDispatcher< ConcreteLhs, BaseRhs, ResultType, TypeTraits< NullType >::ConstReference >
class  wns::DoubleDispatcher< ConcreteLhs, BaseRhs, ResultType, TypeTraits< NullType >::Pointer >
class  wns::DoubleDispatcher< ConcreteLhs, BaseRhs, ResultType, TypeTraits< NullType >::Reference >
class  wns::DoubleDispatcher< ConcreteLhs, const SmartPtr< BaseRhs > &, ResultType, TypeTraits< NullType >::ConstReference >
class  DoubleDispatcherBase
 Base class for the DoubleDispatcher. More...
class  Enumerable
 Make T a enumerable type. More...
class  Enumerator
 Totally static class for enumeration of especially FP values. More...
class  Exception
 Base class of all WNS exceptions. More...
class  Functor
 The base class of the Functor without arguments. More...
class  HasBirthmark
 Provide unique birthmark (identifier) for all clones of one origin. More...
struct  HasReceptorConfigCreator
struct  wns::HasReceptorConfigCreator< KIND, KIND >
class  Interpolation
 Interface and base class for N dimensional interpolation over a container with type T values. More...
class  wns::Interpolation< T, 1 >
 One dimensional specialization for Interpolation. More...
class  Interval
 Interval representation. More...
class  IOutputStreamable
 Enable usage in output streams by deriving from this class (NVI). More...
class  LongCreator
 Creator implementation to be used with StaticFactory. More...
class  wns::LongCreator< KIND, KIND >
class  NearestNeighbour
 N-dimensional Nearest Neighbour Interpolation. More...
class  wns::NearestNeighbour< T, 1 >
 One dimensional specialization of Nearest Neighbour Interpolation. More...
class  NLinear
 N-linear interpolation (linear, bilinear, trilinear...). More...
class  wns::NLinear< T, 1, M >
 One dimensional specialization of NLinear Interpolation. More...
class  NonCopyable
 Prohibits copy construction and copy assignment for a class "A" if you derive "A" from this class. More...
class  NotCloneable
 Default implementation of a not cloneable class. More...
class  NullException
 Thrown by assureNotNull. More...
class  NullType
 Serves as null marker for types. More...
class  Object
 Enables dynamic_cast and offers method to retrieve class name. More...
class  ObjectManager
 Generic object manager. More...
class  Observer
 An observer to a subject. More...
class  ObserverInterface
 An observer's Interface to a subject. More...
class  Positionable
class  PositionableInterface
 Provides an interface for positionable objects. More...
class  PositionObserver
class  Power
 Helps calculating with dBm and mWatt. More...
struct  PyConfigViewCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::PyConfigViewCreator< KIND, KIND >
class  PythonicOutput
 Provide default (pythonic) output for C++ objects. More...
class  Ratio
 Helps calculating with dB. More...
class  RefCountable
 Part of reference counting with SmartPtr. More...
class  RoundRobin
class  SingletonHolder
 Singleton holder to assure that only one instance of the desired type may exist. More...
class  SingletonHolderStaticData
class  SlidingWindow
 provides a way to measure the sum of sample values recorded within a given window duration More...
class  smart_ptr_mem_fun_t
class  SmartPtr
 Intrusive reference counting. More...
class  SmartPtrBase
 Base class to SmartPtr for debugging purpose. More...
class  StaticFactory
 Monostate class keeping a registry of creators for interface-implementations. More...
class  StaticFactoryBroker
 Able to create ELEMENTs from pyconfig::View using StaticFactory. More...
class  wns::StaticFactoryBroker< ELEMENT, Creator< ELEMENT > >
class  wns::StaticFactoryBroker< ELEMENT, PyConfigViewCreator< ELEMENT > >
class  StaticFactoryRegister
 Provide creator interface and register at a StaticFactory. More...
class  StopWatch
 Measures wallclock time in seconds. More...
class  Subject
 A Subject to an observer. More...
class  SubjectInterface
 A subject's Interface to an observer. More...
class  TArgumentFunctor
 The template version of the Functor with one argument This will create a functor for member functions in class T, taking Arg and returning RetVal and being either non-const (default) or const. The last template parameter should always have its default value. More...
class  TestFixture
 Derive from this class instead of CppUnit::TestFixture. More...
class  TFunctor
 The template version of the Functor without arguments This will create a functor for member functions in class T, returning RetVal and being either non-const (default) or const. The last template parameter should always have its default value. More...
class  TimeWeightedAverage
 Build the time weighted average. More...
class  TypeInfo
 A wrapper around type_info. More...
class  TypeTraits
 A template to check various aspects of a type. More...
class  WeightedAverage
 Build the weighted average. More...

Namespaces

namespace  container
 Advanced containers (FastList, ...).
namespace  distribution
namespace  evaluation
namespace  events
namespace  fsm
namespace  geometry
namespace  InterpolationDefs
 Contains definitions valid for all Interpolation-classes.
namespace  ldk
 Layer Development Kit.
namespace  logger
 Logging subsystem of WNS.
namespace  markovchain
namespace  module
namespace  node
 Basic building blocks for a simulation : The Node.
namespace  osi
namespace  probe
namespace  pyconfig
namespace  queuingsystem
namespace  rng
namespace  scheduler
namespace  search
namespace  service
namespace  simulator
namespace  targumentfunctor
 namespace for TArgumentFunctor helper classes
namespace  testing
namespace  testsuite
 Keeps the names for the different test registries.
namespace  tfunctor
 namespace for TFunctor helper classes

Typedefs

typedef double Distance
typedef double Frequency
typedef
wns::service::phy::phymode::PhyModeInterfacePtr 
PhyModePtr
typedef geometry::Point Position
typedef geometry::Vector PositionOffset
typedef std::size_t SizeType

Functions

template<typename T>
void assertMaxRelError (const T &expected, const T &actual, double maxRelativeError, const std::string sourceFile, const std::string sourceLine)
 Asserts that the relative error between "expected" and "actual" is not greater than "maxRelativeError" (used for unit tests).
void assertMaxRelError (const Ratio &expected, const Ratio &actual, double maxRelativeError, const std::string sourceFile, const std::string sourceLine)
 Specialized version for Ratio.
void assertMaxRelError (const Power &expected, const Power &actual, double maxRelativeError, const std::string sourceFile, const std::string sourceLine)
 Specialized version for Power.
template<class SAMPLEGENERATOR>
void assertMeanValue (double expected, SAMPLEGENERATOR &sampleGenerator, unsigned long int maxTrials, const std::string sourceFile, const std::string sourceLine)
template<typename T>
std::auto_ptr< T > clone (const std::auto_ptr< T > &t)
 Type safe cloning of clonable auto_ptr.
template<typename T>
T * clone (T *t)
 Type safe cloning.
std::string demangle (const std::string &symbol)
 Try to demangle "symbol".
template<typename T, typename P>
SmartPtr< T > dynamicCast (const SmartPtr< P > &p)
template<typename T, typename P>
T * dynamicCast (P *p)
std::string failureMessage (const std::string &sourceFile, const std::string &sourceLine, const std::string &expected, const std::string &actual)
 Construct a failure message containing file, line, expected and actual value.
template<typename T>
T * IncRef (T *o)
template<class C, class T>
bool isClass (const T &o)
 Check if object o is an instance of class C.
template<typename T>
Enumerable< T > makeEnumerable (const T &v)
 Make value v enumerable.
std::ostream & operator<< (std::ostream &other, const wns::IOutputStreamable &outputStreamable)
 Ouput stream operator for IOutputSteamable.
template<typename T, typename P>
SmartPtr< T > staticCast (const SmartPtr< P > &p)
template<typename T, typename P>
T * staticCast (P *p)
template<typename TO, typename FROM>
TO to (const FROM &from)
template<typename T>
std::string Ttos (T value)
 Convert values to string.
Helper function for member funtion adapters
template<class RETURNTYPE, class POINTERTYPE>
smart_ptr_mem_fun_t
< RETURNTYPE, POINTERTYPE > 
smart_ptr_mem_fun (RETURNTYPE(POINTERTYPE::*__f)())
 This helper function may be used like the mem_fun and mem_fun_ref functions from the STL.


Typedef Documentation

Definition at line 37 of file Types.hpp.

Definition at line 36 of file Types.hpp.

Definition at line 184 of file PhyModeInterface.hpp.

Definition at line 36 of file Position.hpp.

Definition at line 37 of file Position.hpp.

typedef std::size_t wns::SizeType

Definition at line 35 of file Types.hpp.


Function Documentation

template<typename T>
void wns::assertMaxRelError ( const T &  expected,
const T &  actual,
double  maxRelativeError,
const std::string  sourceFile,
const std::string  sourceLine 
) [inline]

Author:
Marc Schinnenburg <marc@schinnenburg.com>

Definition at line 137 of file TestFixture.hpp.

void wns::assertMaxRelError ( const Ratio &  expected,
const Ratio &  actual,
double  maxRelativeError,
const std::string  sourceFile,
const std::string  sourceLine 
) [inline]

Author:
Marc Schinnenburg <msg@comnets.rwth-aachen.de>

Definition at line 63 of file CppUnit.hpp.

void wns::assertMaxRelError ( const Power &  expected,
const Power &  actual,
double  maxRelativeError,
const std::string  sourceFile,
const std::string  sourceLine 
) [inline]

Author:
Marc Schinnenburg <msg@comnets.rwth-aachen.de>

Definition at line 43 of file CppUnit.hpp.

template<class SAMPLEGENERATOR>
void wns::assertMeanValue ( double  expected,
SAMPLEGENERATOR &  sampleGenerator,
unsigned long int  maxTrials,
const std::string  sourceFile,
const std::string  sourceLine 
) [inline]

Definition at line 79 of file CppUnit.hpp.

template<typename T>
std::auto_ptr<T> wns::clone ( const std::auto_ptr< T > &  t  )  [inline]

Type safe cloning (see clone(T* t)) works also for std::auto_ptr:

std::auto_ptr<CloneableTestClass> original(new CloneableTestClass());
std::auto_ptr<CloneableTestClass> testCopy = wns::clone(original);

Definition at line 166 of file Cloneable.hpp.

template<typename T>
T* wns::clone ( T *  t  )  [inline]

Instead of calling

CloneableTestClass* original = new CloneableTestClass();
CloneableInterface* copy ( original->clone() );
CloneableTestClass* testCopy = dynamic_cast<CloneableTest::CloneableTestClass*>(copy);
you can call
CloneableTestClass* original = new CloneableTestClass();
CloneableTestClass* testCopy = wns::clone(original);
which performs automatic type checking and conversion

Definition at line 150 of file Cloneable.hpp.

std::string wns::demangle ( const std::string &  symbol  ) 

Author:
Marc Schinnenburg <marc@schinnenburg.com>
If symbol is not a vaild name under the rules of the C++ ABI mangling rules, symbol is returned unmodified. If demangling is not available on your system at all this method will also return the symbol name as fallback.

Currently demangling is supported for system where _GNU_EXTENSIONS is defined.

Definition at line 63 of file demangle.cpp.

template<typename T, typename P>
SmartPtr<T> wns::dynamicCast ( const SmartPtr< P > &  p  )  [inline]

Definition at line 472 of file SmartPtr.hpp.

template<typename T, typename P>
T* wns::dynamicCast ( P *  p  )  [inline]

Definition at line 465 of file SmartPtr.hpp.

std::string wns::failureMessage ( const std::string &  sourceFile,
const std::string &  sourceLine,
const std::string &  expected,
const std::string &  actual 
)

Definition at line 85 of file TestFixture.cpp.

template<typename T>
T* wns::IncRef ( T *  o  )  [inline]

Definition at line 34 of file ReferenceModifier.hpp.

template<class C, class T>
bool wns::isClass ( const T &  o  )  [inline]

Parameters:
C Class to check.
o Object to check.
Returns:
true, if o is an instance of class C or a subclass, false otherwise.
isClass<aClass>(anObject) will check, if anObject is an instance of class aClass or one of its subclasses and return true, if this is the case. aClass must be polymorphic.

Definition at line 47 of file isClass.hpp.

template<typename T>
Enumerable<T> wns::makeEnumerable ( const T &  v  )  [inline]

Parameters:
v Convert this value to it's enumerable version.
This function converts v of type T to an Enumerable<T>. It exists primarily to remove the necessity of specifying the type (as in Enumerable<T>(v)).

Definition at line 307 of file Enumerator.hpp.

std::ostream & wns::operator<< ( std::ostream &  other,
const wns::IOutputStreamable outputStreamable 
)

Definition at line 39 of file IOutputStreamable.cpp.

template<class RETURNTYPE, class POINTERTYPE>
const_smart_ptr_mem_fun_t< RETURNTYPE, POINTERTYPE > wns::smart_ptr_mem_fun ( RETURNTYPE(POINTERTYPE::*)()  __f  )  [inline]

Definition at line 546 of file SmartPtr.hpp.

template<typename T, typename P>
SmartPtr<T> wns::staticCast ( const SmartPtr< P > &  p  )  [inline]

Definition at line 486 of file SmartPtr.hpp.

template<typename T, typename P>
T* wns::staticCast ( P *  p  )  [inline]

Definition at line 479 of file SmartPtr.hpp.

template<typename TO, typename FROM>
TO wns::to ( const FROM &  from  )  [inline]

Definition at line 37 of file Conversion.hpp.

template<typename T>
std::string wns::Ttos ( value  )  [inline]

Parameters:
value This will be converted to a string.
Ttos converts a given value of any type to a string, if it can be added to a stringstream using "<<".

Definition at line 44 of file Ttos.hpp.


Generated on Wed Feb 8 03:32:51 2012 for openWNS by  doxygen 1.5.5