Namespaces | Classes | Typedefs | Enumerations | Functions
icl_core Namespace Reference

Namespaces

namespace  config
 

Framework for processing configuration files.


namespace  crypt
 

Contains cryptographic functions.


namespace  dispatch
 

Dispatching framework.


namespace  impl
namespace  internal
namespace  logging
 

Flexible, powerful, configurable logging framework.


namespace  os
 

Namespace for operating system specific implementations.


namespace  perf_mon
namespace  plugin
 

Plugin framework.


namespace  thread

Classes

class  AbstractFunctionObject
class  AnchorFunction
class  Array2D
class  AtScopeEnd
struct  ConvertToRef
struct  ConvertToRef< T & >
struct  DataHeader
struct  DefaultConstruct
struct  ExpectedType
struct  ExpectedTypeIs
struct  Explicit
class  Finalizable
class  KeyValueDirectory
class  KeyValueDirectoryIterator
class  List
class  Map
class  Multimap
class  Noncopyable
struct  Query
class  QueryKeyFunction
class  QueryValueFunction
class  Queue
struct  RemoveMemberPointer
struct  RemoveMemberPointer< T Q::* >
class  RingBuffer
 A simple ring buffer implementation based on std::vector. More...
struct  Scheme
class  SchemeFunction
class  SchemeParser
class  SCPCreateStatic
 Creates objects as static function variables. More...
class  SCPCreateUsingMalloc
 Creates and destroys objects using malloc() and free(). More...
class  SCPCreateUsingNew
 Creates and destroys objects using operator new and operator delete. More...
class  SearchableStack
class  SequenceNumber
class  Set
class  Singleton
class  SLPDefaultLifetime
class  SLPNoDestroy
class  SpecifierFunction
struct  Stamped
struct  StampedBase
class  STMSingleThreaded
 Dummy threading model for single-threaded environments. More...
class  TestListener
class  TimeBase
 Repesents time values. More...
class  TimeSpan
 Repesents absolute times. More...
class  TimeStamp
 Represents absolute times. More...
class  tList
class  tMap
class  tQueue
class  tRingBuffer
 A simple ring buffer implementation based on std::vector. More...
class  tSearchableStack
class  tSequenceNumber
class  tVector
class  UnionFind
class  Vector
class  ZBuffer

Typedefs

typedef void(* DestructionFuncPtr )()
 Helper definition for destruction functions.
typedef List< double > DoubleList
typedef SearchableStack< double > DoubleSearchableStack
typedef Vector< double > DoubleVector
typedef SearchableStack< float > FloaSearchableStack
typedef List< float > FloatList
typedef Vector< float > FloatVector
typedef ICL_CORE_VC_DEPRECATE
SetRelation tSetRelation 
ICL_CORE_GCC_DEPRECATE
typedef int pid_t
typedef std::vector< QueryQueryList
typedef List< int16_tSigned16List
typedef SearchableStack< int16_tSigned16SearchableStack
typedef Vector< int16_tSigned16Vector
typedef List< int32_tSigned32List
typedef SearchableStack< int32_tSigned32SearchableStack
typedef Vector< int32_tSigned32Vector
typedef List< int64_tSigned64List
typedef SearchableStack< int64_tSigned64SearchableStack
typedef Vector< int64_tSigned64Vector
typedef List< int8_tSigned8List
typedef SearchableStack< int8_tSigned8SearchableStack
typedef Vector< int8_tSigned8Vector
typedef std::string String
typedef tList< double > tDoubleList
typedef tSearchableStack< tDouble > tDoubleSearchableStack
typedef tVector< tDouble > tDoubleVector
typedef tList< float > tFloatList
typedef tSearchableStack< tFloat > tFloatSearchableStack
typedef tVector< tFloat > tFloatVector
typedef
ICL_CORE_OS_IMPL_NS::ThreadId 
ThreadId
typedef int32_t ThreadPriority
typedef tList< int16_ttSigned16List
typedef tSearchableStack
< tSigned16 > 
tSigned16SearchableStack
typedef tVector< tSigned16 > tSigned16Vector
typedef tList< int32_ttSigned32List
typedef tSearchableStack
< tSigned32 > 
tSigned32SearchableStack
typedef tVector< tSigned32 > tSigned32Vector
typedef tList< int64_ttSigned64List
typedef tSearchableStack
< tSigned64 > 
tSigned64SearchableStack
typedef tVector< tSigned64 > tSigned64Vector
typedef tList< int8_ttSigned8List
typedef tSearchableStack
< tSigned8 > 
tSigned8SearchableStack
typedef tVector< tSigned8 > tSigned8Vector
typedef tList< uint16_ttUnsigned16List
typedef tSearchableStack
< tUnsigned16 > 
tUnsigned16SearchableStack
typedef tVector< tUnsigned16 > tUnsigned16Vector
typedef tList< uint32_ttUnsigned32List
typedef tSearchableStack
< tUnsigned32 > 
tUnsigned32SearchableStack
typedef tVector< tUnsigned32 > tUnsigned32Vector
typedef tList< uint64_ttUnsigned64List
typedef tSearchableStack
< tUnsigned64 > 
tUnsigned64SearchableStack
typedef tVector< tUnsigned64 > tUnsigned64Vector
typedef tList< uint8_ttUnsigned8List
typedef tSearchableStack
< tUnsigned8 > 
tUnsigned8SearchableStack
typedef tVector< tUnsigned8 > tUnsigned8Vector
typedef List< uint16_tUnsigned16List
typedef SearchableStack< uint16_tUnsigned16SearchableStack
typedef Vector< uint16_tUnsigned16Vector
typedef List< uint32_tUnsigned32List
typedef SearchableStack< uint32_tUnsigned32SearchableStack
typedef Vector< uint32_tUnsigned32Vector
typedef List< uint64_tUnsigned64List
typedef SearchableStack< uint64_tUnsigned64SearchableStack
typedef Vector< uint64_tUnsigned64Vector
typedef List< uint8_tUnsigned8List
typedef SearchableStack< uint8_tUnsigned8SearchableStack
typedef Vector< uint8_tUnsigned8Vector

Enumerations

enum  SchemeType {
  FileScheme, HttpScheme, CameraScheme, GpsScheme,
  OtherScheme
}
enum  SetRelation {
  eSR_EQUAL, eSR_PROPER_SUPERSET, eSR_PROPER_SUBSET, eSR_INTERSECTION_NONEMPTY,
  eSR_DISJUNCT
}
 Helper enum to describe relations between sets. More...
enum  TestResultOutputType { eTROT_Text, eTROT_Compiler, eTROT_Xml }

Functions

TimeSpan abs (const TimeSpan &span)
template<typename T >
void clearBits (int bits, typename ConvertToRef< T >::ToRef bitfield)
template<>
void convert (const Foo &from, Bar &to)
template<>
void convert (const Bar &from, Foo &to)
template<typename TTo , typename TFrom >
void convert (const TFrom &from, TTo &to)
template<typename TTo , typename TFrom >
TTo convert (const TFrom &from)
template<typename T >
bool isBitSet (int bit, typename ConvertToRef< T >::ToConstRef bitfield)
String join (const std::vector< String > &substrings, const String &delimiter)
TimeSpan operator* (const TimeSpan &span, double divisor)
TimeSpan operator+ (const TimeSpan &left, const TimeSpan &right)
TimeStamp operator+ (const TimeSpan &span, const TimeStamp &time)
TimeStamp operator+ (const TimeStamp &time, const TimeSpan &span)
TimeSpan operator- (const TimeSpan &left, const TimeSpan &right)
TimeStamp operator- (const TimeStamp &time, const TimeSpan &span)
TimeSpan operator- (const TimeStamp &time_1, const TimeStamp &time_2)
TimeSpan operator/ (const TimeSpan &span, double divisor)
std::ostream & operator<< (std::ostream &os, StampedBase const &stamped)
std::ostream & operator<< (std::ostream &stream, const Scheme &scheme)
std::ostream & operator<< (std::ostream &os, const TimeStamp &t)
std::ostream & operator<< (std::ostream &stream, const TimeSpan &time_span)
 Write a time span to an STL output stream.
template<typename T >
String padLeft (typename ConvertToRef< T >::ToConstRef x, size_t width, char pad_chr= ' ')
template<>
String padLeft< String > (const String &str, size_t width, char pad_chr)
template<typename T >
String padRight (typename ConvertToRef< T >::ToConstRef x, size_t width, char pad_chr= ' ')
template<>
String padRight< String > (const String &str, size_t width, char pad_chr)
int runCppunitTestSuite (TestResultOutputType outputType)
template<typename T >
void setBits (int bits, typename ConvertToRef< T >::ToRef bitfield)
template<typename T , typename TCompare >
SetRelation setRelation (const std::set< T, TCompare > &s1, const std::set< T, TCompare > &s2)
std::vector< Stringsplit (const String &str, const String &delimiter)
bool string2Enum (const String &str, int32_t &value, const char *const *descriptions, const char *end_marker)
bool string2Enum (const String &str, int32_t &value, const std::vector< std::string > &descriptions)
bool string2Enum (const String &str, int64_t &value, const std::vector< std::string > &descriptions)
template<typename T >
String stringify (typename ConvertToRef< T >::ToConstRef x)
template<>
String stringify< bool > (const bool &x)
template<>
String stringify< double > (const double &x)
template<>
String stringify< float > (const float &x)
template<>
String stringify< long double > (const long double &x)
String toLower (icl_core::String str)
String toUpper (icl_core::String str)
String trim (String const &str)

Detailed Description

Independent Component Library containing core functionality.


Typedef Documentation

typedef void(* icl_core::DestructionFuncPtr)()

Helper definition for destruction functions.

Definition at line 40 of file SingletonLifetimePolicies.h.

typedef List<double> icl_core::DoubleList

Definition at line 59 of file List.h.

Definition at line 104 of file SearchableStack.h.

typedef Vector<double> icl_core::DoubleVector

Definition at line 59 of file Vector.h.

Definition at line 103 of file SearchableStack.h.

typedef List<float> icl_core::FloatList

Definition at line 58 of file List.h.

typedef Vector<float> icl_core::FloatVector

Definition at line 58 of file Vector.h.

Definition at line 42 of file SetHelper.h.

typedef int icl_core::pid_t

Definition at line 34 of file os_win32_thread.h.

typedef std::vector<Query> icl_core::QueryList

Definition at line 61 of file SchemeParser.h.

Definition at line 55 of file List.h.

Definition at line 100 of file SearchableStack.h.

Definition at line 55 of file Vector.h.

Definition at line 56 of file List.h.

Definition at line 101 of file SearchableStack.h.

Definition at line 56 of file Vector.h.

Definition at line 57 of file List.h.

Definition at line 102 of file SearchableStack.h.

Definition at line 57 of file Vector.h.

Definition at line 54 of file List.h.

Definition at line 99 of file SearchableStack.h.

Definition at line 54 of file Vector.h.

typedef std::string icl_core::String

Definition at line 43 of file BaseTypes.h.

typedef tList<double> icl_core::tDoubleList

Definition at line 51 of file tList.h.

Definition at line 105 of file tSearchableStack.h.

typedef tVector<tDouble> icl_core::tDoubleVector

Definition at line 60 of file tVector.h.

typedef tList<float> icl_core::tFloatList

Definition at line 50 of file tList.h.

Definition at line 104 of file tSearchableStack.h.

Definition at line 59 of file tVector.h.

typedef ICL_CORE_OS_IMPL_NS::ThreadId icl_core::ThreadId

Definition at line 49 of file os_thread.h.

Definition at line 50 of file os_thread.h.

Definition at line 47 of file tList.h.

Definition at line 101 of file tSearchableStack.h.

typedef tVector<tSigned16> icl_core::tSigned16Vector

Definition at line 56 of file tVector.h.

Definition at line 48 of file tList.h.

Definition at line 102 of file tSearchableStack.h.

typedef tVector<tSigned32> icl_core::tSigned32Vector

Definition at line 57 of file tVector.h.

Definition at line 49 of file tList.h.

Definition at line 103 of file tSearchableStack.h.

typedef tVector<tSigned64> icl_core::tSigned64Vector

Definition at line 58 of file tVector.h.

Definition at line 46 of file tList.h.

Definition at line 100 of file tSearchableStack.h.

typedef tVector<tSigned8> icl_core::tSigned8Vector

Definition at line 55 of file tVector.h.

Definition at line 43 of file tList.h.

Definition at line 97 of file tSearchableStack.h.

typedef tVector<tUnsigned16> icl_core::tUnsigned16Vector

Definition at line 52 of file tVector.h.

Definition at line 44 of file tList.h.

Definition at line 98 of file tSearchableStack.h.

typedef tVector<tUnsigned32> icl_core::tUnsigned32Vector

Definition at line 53 of file tVector.h.

Definition at line 45 of file tList.h.

Definition at line 99 of file tSearchableStack.h.

typedef tVector<tUnsigned64> icl_core::tUnsigned64Vector

Definition at line 54 of file tVector.h.

Definition at line 42 of file tList.h.

Definition at line 96 of file tSearchableStack.h.

typedef tVector<tUnsigned8> icl_core::tUnsigned8Vector

Definition at line 51 of file tVector.h.

Definition at line 51 of file List.h.

Definition at line 96 of file SearchableStack.h.

Definition at line 51 of file Vector.h.

Definition at line 52 of file List.h.

Definition at line 97 of file SearchableStack.h.

Definition at line 52 of file Vector.h.

Definition at line 53 of file List.h.

Definition at line 98 of file SearchableStack.h.

Definition at line 53 of file Vector.h.

Definition at line 50 of file List.h.

Definition at line 95 of file SearchableStack.h.

Definition at line 50 of file Vector.h.


Enumeration Type Documentation

Enumerator:
FileScheme 

file:///path/file?key=value

HttpScheme 

http://domain.org/path/to/site.ext?key=value

CameraScheme 

camera://source?key=value

GpsScheme 

gps://type (gpsd/oxfs/...)

OtherScheme 

Definition at line 63 of file SchemeParser.h.

Helper enum to describe relations between sets.

Enumerator:
eSR_EQUAL 
eSR_PROPER_SUPERSET 
eSR_PROPER_SUBSET 
eSR_INTERSECTION_NONEMPTY 
eSR_DISJUNCT 

Definition at line 33 of file SetHelper.h.

Enumerator:
eTROT_Text 

Output on stderr with a textual overview and summary. Optimized for human readability.

eTROT_Compiler 

Output on stderr with a textual overview and summary. Compiler-like output of assertions to help your IDE parse the output.

eTROT_Xml 

Output on stderr in xml format

Definition at line 34 of file test_suite.h.


Function Documentation

TimeSpan icl_core::abs ( const TimeSpan &  span) [inline]

Definition at line 222 of file TimeSpan.h.

template<typename T >
void icl_core::clearBits ( int  bits,
typename ConvertToRef< T >::ToRef  bitfield 
)

Clears the specified bits in the bitfield.

Definition at line 49 of file BitfieldHelper.h.

template<>
void icl_core::convert ( const Foo from,
Bar to 
)

Definition at line 53 of file test_icl_core_convert.cpp.

template<>
void icl_core::convert ( const Bar from,
Foo to 
)

Definition at line 59 of file test_icl_core_convert.cpp.

template<typename TTo , typename TFrom >
void icl_core::convert ( const TFrom &  from,
TTo &  to 
)

Convert an object from to an object to which has a semantically compatible datatype. This concept is designed to help get rid of the multitude of custom, signature-incompatible, badly documented conversion routines, and provide the user of your datatypes with a single, convenient way of converting between different semantically compatible types. The default implementation here simply uses static_cast. If you want to convert between two datatypes, such as different types of 3d transforms, a custom conversion method may be necessary and can be implemented by template specialization of this function. Say, for example, you want to provide a converter from Eigen::Affine3d to your own custom 3D transform datatype (we'll call it CustomTransform). Then you implement the following specialization:

  template <>
  void convert<CustomTransform, Eigen::Affine3d>(const Eigen::Affine3d& from, CustomTransform& to)
  {
    // Your implementation goes here.
  }

Anyone who needs a conversion between the two datatypes can then simply write

  Eigen::Affine3d some_tf = ...;
  CustomTransform my_tf = icl_core::convert<CustomTransform>(some_tf);
  // Or alternatively:
  CustomTransform my_tf; icl_core::convert<CustomTransform>(some_tf, my_tf);
Note:
Some information loss may take place if TTo does not support all the features of TFrom. This means that
  convert<From>(convert<To>(from)) == from 
does not necessarily hold!
Parameters:
[in]fromAn object of type TFrom.
[out]toAn object of type TTO.

Definition at line 67 of file Convert.h.

template<typename TTo , typename TFrom >
TTo icl_core::convert ( const TFrom &  from)

Convenience wrapper for

See also:
void convert<TTo, TFrom>(const TFrom&, TTo&). You can provide a template specialization of this for your own datatypes if you have a more performant way to implement this method.
Note:
Some information loss may take place if TTo does not support all the features of TFrom. This means that
  convert<From>(convert<To>(from)) == from 
does not necessarily hold!
Parameters:
fromAn object of type TFrom.
Returns:
An object of type TTo which is semantically equivalent to the original from. Some information loss may take place if TTo does not support all the features of TFrom.

Definition at line 87 of file Convert.h.

template<typename T >
bool icl_core::isBitSet ( int  bit,
typename ConvertToRef< T >::ToConstRef  bitfield 
)

Checks if the specified bit is set in the bitfield.

Definition at line 58 of file BitfieldHelper.h.

ICL_CORE_IMPORT_EXPORT String icl_core::join ( const std::vector< String > &  substrings,
const String &  delimiter 
)

The reverse operation of split(const String&, const String&). Joins all the substrings, separated by delimiter.

Parameters:
substringsThe substrings to join.
delimiterThe delimiter string.

Definition at line 49 of file StringHelper.cpp.

TimeSpan icl_core::operator* ( const TimeSpan &  span,
double  divisor 
) [inline]

Definition at line 216 of file TimeSpan.h.

TimeSpan icl_core::operator+ ( const TimeSpan &  left,
const TimeSpan &  right 
) [inline]

Definition at line 198 of file TimeSpan.h.

TimeStamp icl_core::operator+ ( const TimeSpan &  span,
const TimeStamp &  time 
) [inline]

Definition at line 343 of file TimeStamp.h.

TimeStamp icl_core::operator+ ( const TimeStamp &  time,
const TimeSpan &  span 
) [inline]

Definition at line 349 of file TimeStamp.h.

TimeSpan icl_core::operator- ( const TimeSpan &  left,
const TimeSpan &  right 
) [inline]

Definition at line 204 of file TimeSpan.h.

TimeStamp icl_core::operator- ( const TimeStamp &  time,
const TimeSpan &  span 
) [inline]

Definition at line 355 of file TimeStamp.h.

TimeSpan icl_core::operator- ( const TimeStamp &  time_1,
const TimeStamp &  time_2 
) [inline]

Definition at line 361 of file TimeStamp.h.

TimeSpan icl_core::operator/ ( const TimeSpan &  span,
double  divisor 
) [inline]

Definition at line 210 of file TimeSpan.h.

ICL_CORE_IMPORT_EXPORT std::ostream & icl_core::operator<< ( std::ostream &  os,
StampedBase const &  stamped 
)

operator << to stream StampedBase to an ostream. Internally it calls the virtual print() function that is overloaded by the Stamped<T> implementation.

Definition at line 27 of file DataHeader.cpp.

std::ostream& icl_core::operator<< ( std::ostream &  stream,
const Scheme &  scheme 
)

Definition at line 29 of file SchemeParser.cpp.

std::ostream& icl_core::operator<< ( std::ostream &  os,
const TimeStamp t 
)

Definition at line 29 of file ts_TimeStamp.cpp.

ICL_CORE_IMPORT_EXPORT std::ostream & icl_core::operator<< ( std::ostream &  stream,
const TimeSpan &  time_span 
)

Write a time span to an STL output stream.

Definition at line 229 of file TimeSpan.cpp.

template<typename T >
String icl_core::padLeft ( typename ConvertToRef< T >::ToConstRef  x,
size_t  width,
char  pad_chr = ' ' 
)

Definition at line 100 of file StringHelper.h.

template<>
String icl_core::padLeft< String > ( const String &  str,
size_t  width,
char  pad_chr 
) [inline]

Definition at line 106 of file StringHelper.h.

template<typename T >
String icl_core::padRight ( typename ConvertToRef< T >::ToConstRef  x,
size_t  width,
char  pad_chr = ' ' 
)

Definition at line 120 of file StringHelper.h.

template<>
String icl_core::padRight< String > ( const String &  str,
size_t  width,
char  pad_chr 
) [inline]

Definition at line 126 of file StringHelper.h.

ICL_CORE_TESTSUITE_IMPORT_EXPORT int icl_core::runCppunitTestSuite ( TestResultOutputType  outputType)

Definition at line 40 of file test_suite.cpp.

template<typename T >
void icl_core::setBits ( int  bits,
typename ConvertToRef< T >::ToRef  bitfield 
)

Sets the specified bits in the bitfield.

Definition at line 40 of file BitfieldHelper.h.

template<typename T , typename TCompare >
SetRelation icl_core::setRelation ( const std::set< T, TCompare > &  s1,
const std::set< T, TCompare > &  s2 
)

Generic helper function to determine the relationships between two sets.

Definition at line 47 of file SetHelper.h.

ICL_CORE_IMPORT_EXPORT std::vector< String > icl_core::split ( const String &  str,
const String &  delimiter 
)

Simple string splitting method. Given a string str, which contains substrings separated by delimiter, returns a vector of the substrings. E.g., split("foo;bar;baz") returns a vector containing the elements "foo", "bar" and "baz". If str is empty, returns a vector containing one element, the empty string.

Parameters:
strThe string to split.
delimiterThe delimiter string.

Definition at line 27 of file StringHelper.cpp.

bool ICL_CORE_IMPORT_EXPORT icl_core::string2Enum ( const String &  str,
int32_t value,
const char *const *  descriptions,
const char *  end_marker = NULL 
)

Converts a string to an enumeration value. The descriptions for the individual enumeration values have to be provided in an array, which is terminated by a NULL entry.

Parameters:
strA string, which should be converted into an enumeration value.
valueThe enumeration value into which the result will be written.
descriptionsAn array of descriptions for the enumeration values, terminated by the end_marker.
end_markerThe end marker used to terminate the description array.
Returns:
true if str has been found in descriptions. In this case value is set to the corresponding index. false if str could not be found in descriptions.

Definition at line 28 of file EnumHelper.cpp.

bool ICL_CORE_IMPORT_EXPORT icl_core::string2Enum ( const String &  str,
int32_t value,
const std::vector< std::string > &  descriptions 
)

Definition at line 70 of file EnumHelper.cpp.

bool ICL_CORE_IMPORT_EXPORT icl_core::string2Enum ( const String &  str,
int64_t value,
const std::vector< std::string > &  descriptions 
)

Definition at line 76 of file EnumHelper.cpp.

template<typename T >
String icl_core::stringify ( typename ConvertToRef< T >::ToConstRef  x)

Definition at line 47 of file StringHelper.h.

template<>
String icl_core::stringify< bool > ( const bool &  x) [inline]

Definition at line 55 of file StringHelper.h.

template<>
String icl_core::stringify< double > ( const double &  x) [inline]

Definition at line 62 of file StringHelper.h.

template<>
String icl_core::stringify< float > ( const float &  x) [inline]

Definition at line 70 of file StringHelper.h.

template<>
String icl_core::stringify< long double > ( const long double &  x) [inline]

Definition at line 78 of file StringHelper.h.

Definition at line 86 of file StringHelper.h.

Definition at line 92 of file StringHelper.h.

ICL_CORE_IMPORT_EXPORT String icl_core::trim ( String const &  str)

Definition at line 63 of file StringHelper.cpp.



fzi_icl_core
Author(s):
autogenerated on Tue Aug 8 2017 02:28:05