Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
ecl Namespace Reference

Embedded control libraries. More...

Namespaces

 blueprints
 Blueprints and factories classes used to generate blueprints (do not use directly).
 
 concepts
 
 containers
 Supporting elements and interfaces for ecl containers.
 
 formatters
 Supporting classes for container formatters (do not use directly).
 
 interfaces
 

Classes

class  Array
 Fixed size container with a few bells and whistles. More...
 
class  Array< Type, DynamicStorage >
 Dynamic size container with a few bells and whistles. More...
 
class  BinaryFunction
 
class  BluePrint
 
class  BluePrintConcept
 
class  BluePrintFactory
 
class  BluePrintFactory< Array< Type, DynamicStorage > >
 Blueprint factory for dynamic arrays. More...
 
class  Bool
 
class  BoundNullaryMemberFunction
 
class  BoundNullaryMemberFunction< C, void >
 
class  BoundUnaryFreeFunction
 
class  BoundUnaryFreeFunction< A, void >
 
class  BoundUnaryMemberFunction
 
class  ByteContainerConcept
 
class  ContainerConcept
 
class  Converter
 
class  Converter< Array< char >, Integral >
 Specialisation for integral to char Array conversions. More...
 
class  Converter< Array< signed char >, Integral >
 Specialisation for integral to signed char Array conversions. More...
 
class  Converter< Array< unsigned char >, Integral >
 Specialisation for integral to signed char Array conversions. More...
 
class  Converter< char *, bool >
 
class  Converter< char *, char >
 
class  Converter< char *, double >
 
class  Converter< char *, float >
 
class  Converter< char *, int >
 
class  Converter< char *, long >
 
class  Converter< char *, long long >
 
class  Converter< char *, short >
 
class  Converter< char *, unsigned char >
 
class  Converter< char *, unsigned int >
 
class  Converter< char *, unsigned long >
 
class  Converter< char *, unsigned long long >
 
class  Converter< char *, unsigned short >
 
class  Converter< char *, void >
 
class  Converter< char, int >
 
class  Converter< char, unsigned int >
 
class  Converter< char, void >
 
class  Converter< int, char * >
 
class  Converter< int, char >
 
class  Converter< int, std::string >
 
class  Converter< int, unsigned char * >
 
class  Converter< int, void >
 
class  Converter< Integral, Array< char, Size > >
 Specialisation for char Array container based FromByteArray converter. More...
 
class  Converter< Integral, Array< signed char, Size > >
 Specialisation for signed char Array container based FromByteArray converter. More...
 
class  Converter< Integral, Array< unsigned char, Size > >
 Specialisation for the unsigned char Array container based FromByteArray converter. More...
 
class  Converter< Integral, std::vector< char > >
 
class  Converter< Integral, std::vector< signed char > >
 
class  Converter< Integral, std::vector< unsigned char > >
 
class  Converter< Integral, Stencil< Array< char, Size > > >
 Specialisation for char Stencil container based FromByteArray converter. More...
 
class  Converter< Integral, Stencil< Array< signed char, Size > > >
 Specialisation for signed char Stencil container based FromByteArray converter. More...
 
class  Converter< Integral, Stencil< Array< unsigned char, Size > > >
 Specialisation for unsigned char Stencil container based FromByteArray converter. More...
 
class  Converter< Integral, Stencil< const unsigned char * > >
 Specialisation for const unsigned char* Stencil container based FromByteArray converter. More...
 
class  Converter< Output, void >
 
class  Converter< std::string, int >
 
class  Converter< std::string, void >
 
class  Converter< std::vector< char >, char * >
 
class  Converter< std::vector< char >, int >
 
class  Converter< std::vector< char >, long >
 
class  Converter< std::vector< char >, long long >
 
class  Converter< std::vector< char >, unsigned int >
 
class  Converter< std::vector< char >, unsigned long >
 
class  Converter< std::vector< char >, void >
 
class  Converter< std::vector< signed char >, int >
 
class  Converter< std::vector< signed char >, long >
 
class  Converter< std::vector< signed char >, long long >
 
class  Converter< std::vector< signed char >, unsigned int >
 
class  Converter< std::vector< signed char >, unsigned long >
 
class  Converter< std::vector< signed char >, void >
 
class  Converter< std::vector< unsigned char >, int >
 
class  Converter< std::vector< unsigned char >, long >
 
class  Converter< std::vector< unsigned char >, long long >
 
class  Converter< std::vector< unsigned char >, unsigned int >
 
class  Converter< std::vector< unsigned char >, unsigned long >
 
class  Converter< std::vector< unsigned char >, void >
 
class  Converter< Stencil< Array< char, Size > >, Integral >
 Specialisation for integral to char Stencil conversions. More...
 
class  Converter< Stencil< Array< signed char, Size > >, Integral >
 Specialisation for integral to signed char Stencil conversions. More...
 
class  Converter< Stencil< Array< unsigned char, Size > >, Integral >
 Specialisation for integral to unsigned char Stencil conversions. More...
 
class  Converter< Stencil< std::vector< unsigned char > >, int >
 Specialisation for int to vector based unsigned char Stencil container. More...
 
class  Converter< Stencil< std::vector< unsigned char > >, long >
 Specialisation for long to vector based unsigned char Stencil container. More...
 
class  Converter< Stencil< std::vector< unsigned char > >, long long >
 Specialisation for long long to vector based unsigned char Stencil container. More...
 
class  Converter< Stencil< std::vector< unsigned char > >, unsigned int >
 Specialisation for unsigned int to vector based unsigned char Stencil container. More...
 
class  DataException
 
class  DynamicContainerConcept
 
struct  ecl_traits
 
struct  enable_if
 
struct  enable_if_c
 
struct  enable_if_c< false, T >
 
class  Error
 
class  Exception
 
class  FailedObject
 
class  FiFo
 Really simple fifo implementation. More...
 
class  Flags
 
class  Format
 
class  Format< char >
 
class  Format< double >
 
class  Format< float >
 
class  Format< int >
 
class  Format< long >
 
class  Format< short >
 
class  Format< signed char >
 
class  Format< std::string >
 
class  Format< unsigned char >
 
class  Format< unsigned int >
 
class  Format< unsigned long >
 
class  Format< unsigned short >
 
struct  if_c
 
struct  if_c< false, T1, T2 >
 
class  InputByteDeviceConcept
 
class  InputCharDeviceConcept
 
class  InputOutputByteDeviceConcept
 
class  InputOutputCharDeviceConcept
 
class  is_byte
 
class  is_byte< char >
 
class  is_byte< signed char >
 
class  is_byte< unsigned char >
 
class  is_float
 
class  is_float< double >
 
class  is_float< float >
 
class  is_float< long double >
 
class  is_integral
 
class  is_integral< char >
 
class  is_integral< int >
 
class  is_integral< long >
 
class  is_integral< long long >
 
class  is_integral< short >
 
class  is_integral< unsigned char >
 
class  is_integral< unsigned int >
 
class  is_integral< unsigned long >
 
class  is_integral< unsigned long long >
 
class  is_integral< unsigned short >
 
class  is_reference_wrapper
 
class  is_reference_wrapper< ReferenceWrapper< T > >
 
class  is_signed
 
class  is_signed< char >
 
class  is_signed< int >
 
class  is_signed< long >
 
class  is_signed< long long >
 
class  is_signed< short >
 
class  is_signed_byte
 
class  is_signed_byte< char >
 
class  is_signed_byte< signed char >
 
class  is_unsigned
 
class  is_unsigned< unsigned char >
 
class  is_unsigned< unsigned int >
 
class  is_unsigned< unsigned long >
 
class  is_unsigned< unsigned long long >
 
class  is_unsigned< unsigned short >
 
class  is_unsigned_byte
 
class  is_unsigned_byte< char >
 
class  is_unsigned_byte< unsigned char >
 
class  NullaryFreeFunction
 
class  NullaryFreeFunction< void >
 
class  NullaryFunction
 
class  NullaryFunctionConcept
 
class  NullaryFunctionCopy
 
class  NullaryFunctionCopy< FunctionObject, void >
 
class  NullaryFunctionReference
 
class  NullaryFunctionReference< FunctionObject, void >
 
class  NullaryMemberFunction
 
class  NullaryMemberFunction< C, void >
 
class  numeric_limits
 
class  numeric_limits< char >
 
class  numeric_limits< double >
 
class  numeric_limits< float >
 
class  numeric_limits< int >
 
class  numeric_limits< long >
 
class  numeric_limits< long double >
 
class  numeric_limits< long long >
 
class  numeric_limits< short >
 
class  numeric_limits< unsigned char >
 
class  numeric_limits< unsigned int >
 
class  numeric_limits< unsigned long >
 
class  numeric_limits< unsigned long long >
 
class  numeric_limits< unsigned short >
 
class  OutputByteDeviceConcept
 
class  OutputCharDeviceConcept
 
class  Parameter
 
class  PartiallyBoundBinaryMemberFunction
 
class  PartiallyBoundUnaryMemberFunction
 
class  PosixErrorHandler
 
struct  PrecisionWidth
 
struct  PrecisionWidth< double >
 
struct  PrecisionWidth< float >
 
class  PushAndPop
 Surpport push and pack operation. More...
 
class  PushAndPop< Type, DynamicStorage >
 Surpport push and pack operation. More...
 
class  ReferenceWrapper
 
class  SignedByteContainerConcept
 
class  Singleton
 
class  StandardException
 
class  Stencil
 A safe windowing class that opens onto array-like containers. More...
 
class  Stencil< const unsigned char * >
 Stencil variant operating on a raw const unsigned char array. More...
 
class  Stencil< unsigned char * >
 Stencil variant operating on a raw unsigned char array. More...
 
class  StreamConcept
 
class  UnaryFreeFunction
 
class  UnaryFreeFunction< A, void >
 
class  UnaryFunction
 
class  UnaryFunctionCopy
 
class  UnaryFunctionCopy< FunctionObject, T, void >
 
class  UnaryFunctionReference
 
class  UnaryFunctionReference< ReferenceWrapper, T, void >
 
class  UnaryMemberFunction
 
class  UnaryMemberFunction< C, A, void >
 
struct  Unsigned
 
struct  Unsigned< char >
 
struct  Unsigned< int >
 
struct  Unsigned< long >
 
struct  Unsigned< long long >
 
struct  Unsigned< short >
 
struct  Unsigned< unsigned char >
 
struct  Unsigned< unsigned int >
 
struct  Unsigned< unsigned long >
 
struct  Unsigned< unsigned long long >
 
struct  Unsigned< unsigned short >
 
class  UnsignedByteContainerConcept
 
class  Void
 

Typedefs

typedef Bool< false > False
 
typedef Bool< true > True
 
typedef void(* VoidFunction) ()
 

Enumerations

enum  Alignment
 
enum  Bits
 
enum  ErrorFlag
 
enum  FloatBase
 
enum  IntegralBase
 
enum  StorageType { DynamicStorage = 0, FixedStorage = 1 }
 A simple flag for denoting the storage type of the container. More...
 

Functions

T * addressOf (T &v)
 
ReferenceWrapper< T const > cref (T const &wrapped_object)
 
NullaryFreeFunction< R > generateFunctionObject (R(*function)())
 
UnaryFreeFunction< A, R > generateFunctionObject (R(*function)(A))
 
BoundUnaryFreeFunction< A, R > generateFunctionObject (R(*function)(A), const I &a)
 
BoundUnaryFreeFunction< A, R > generateFunctionObject (R(*function)(A), I &a)
 
NullaryMemberFunction< C, R > generateFunctionObject (R(C::*function)())
 
BoundNullaryMemberFunction< C, R > generateFunctionObject (R(C::*function)(), C &c)
 
UnaryMemberFunction< C, A, R > generateFunctionObject (R(C::*function)(A))
 
PartiallyBoundUnaryMemberFunction< C, A, R > generateFunctionObject (R(C::*function)(A), C &c)
 
BoundUnaryMemberFunction< C, A, R > generateFunctionObject (R(C::*function)(A), C &c, const I &a)
 
BoundUnaryMemberFunction< C, A, R > generateFunctionObject (R(C::*function)(A), C &c, I &a)
 
bool is_big_endian ()
 
bool is_char_signed ()
 
template<typename OutputStream , typename ElementType , size_t ArraySize>
OutputStream & operator<< (OutputStream &ostream, const Array< ElementType, ArraySize > &array)
 
template<typename OutputStream , typename ElementType >
OutputStream & operator<< (OutputStream &ostream, const Array< ElementType, DynamicStorage > &array)
 
template<typename OutputStream , typename ArrayType >
OutputStream & operator<< (OutputStream &ostream, const Stencil< ArrayType > &stencil)
 
OutputStream & operator<< (OutputStream &ostream, const Void void_object)
 
OutputStream & operator<< (OutputStream &ostream, Format< std::string > &formatter)
 
ReferenceWrapper< T > ref (T &wrapped_object)
 

Variables

 ArgNotSupportedError
 
 Bin
 
 Bit0
 
 Bit1
 
 Bit10
 
 Bit11
 
 Bit12
 
 Bit13
 
 Bit14
 
 Bit15
 
 Bit16
 
 Bit2
 
 Bit3
 
 Bit4
 
 Bit5
 
 Bit6
 
 Bit7
 
 Bit8
 
 Bit9
 
 BlockingError
 
 BusyError
 
 CentreAlign
 
 CloseError
 
 ConfigurationError
 
 ConnectionError
 
 ConnectionRefusedError
 
 ConstructorError
 
 ConversionError
 
 Dec
 
 DestructorError
 
 Fixed
 
 Hex
 
 InterruptedError
 
 InvalidArgError
 
 InvalidInputError
 
 InvalidObjectError
 
 IsLockedError
 
 LeftAlign
 
 MemoryError
 
 NoAlign
 
 NoError
 
 NotFoundError
 
 NotInitialisedError
 
 NotSupportedError
 
 OpenError
 
 OutOfRangeError
 
 OutOfResourcesError
 
 PermissionsError
 
 PosixError
 
 RaiiError
 
 ReadError
 
 RightAlign
 
 Sci
 
 SystemFailureError
 
 TimeOutError
 
 UnknownError
 
 UsageError
 
 WriteError
 

Detailed Description

Embedded control libraries.

Various core libraries useful for embedded control systems.

Enumeration Type Documentation

◆ StorageType

A simple flag for denoting the storage type of the container.

This simply denotes whether the container is dynamic or fixed memory. Currently it is only used under the hood on the Array container. Users should not need to use this directly.

Enumerator
DynamicStorage 

Dynamic

FixedStorage 

Fixed

Definition at line 35 of file definitions.hpp.

Function Documentation

◆ operator<<() [1/3]

template<typename OutputStream , typename ElementType , size_t ArraySize>
OutputStream& ecl::operator<< ( OutputStream &  ostream,
const Array< ElementType, ArraySize > &  array 
)

Insertion operator for sending the array to an output stream. This is raw, and has no formatting.

Parameters
ostream: the output stream.
array: the array to be inserted.
Returns
OutputStream : continue streaming with the updated output stream.

Definition at line 370 of file array_no_mem_check.hpp.

◆ operator<<() [2/3]

template<typename OutputStream , typename ElementType >
OutputStream & ecl::operator<< ( OutputStream &  ostream,
const Array< ElementType, DynamicStorage > &  array 
)

Insertion operator for sending the array to an output stream. This is raw, and has no formatting.

Parameters
ostream: the output stream.
array: the array to be inserted.
Returns
OutputStream : continue streaming with the updated output stream.

Definition at line 654 of file array_dynamic_mem_check.hpp.

◆ operator<<() [3/3]

template<typename OutputStream , typename ArrayType >
OutputStream& ecl::operator<< ( OutputStream &  ostream,
const Stencil< ArrayType > &  stencil 
)

Insertion operator for sending the stencil to an output stream. This is raw, and has no formatting.

Concept Check: makes sure the template parameter provided for the stream is a stream type with the required functionality.

Parameters
ostream: the output stream.
stencil: the stencil to be inserted.
Template Parameters
OutputStream: the stream being used.
ArrayType: the type of the underlying array.
Returns
OutputStream : continue streaming with the updated output stream.

Definition at line 516 of file stencil/stencil.hpp.



ecl_containers
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:14