ecl Namespace Reference

Embedded control libraries. More...

Namespaces
namespace	interfaces
	Supporting elements and interfaces.
Classes
class	Format
	Primary template for all formatter classes. More...
class	Format< char >
	Formatter for char types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< double >
	Formatter for double types. More...
class	Format< float >
	Formatter for float types. More...
class	Format< int >
	Formatter for int types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< long >
	Formatter for long types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< short >
	Formatter for short types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< signed char >
	Formatter for signed char types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< std::string >
	Formatter for string types. More...
class	Format< unsigned char >
	Formatter for unsigned char types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< unsigned int >
	Formatter for unsigned int types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< unsigned long >
	Formatter for unsigned long types. It is a specialisation of the Format<IntegralNumber> class. More...
class	Format< unsigned short >
	Formatter for unsigned short types. It is a specialisation of the Format<IntegralNumber> class. More...
struct	PrecisionWidth
	Precision width trait for fundamental types. More...
struct	PrecisionWidth< double >
	Precision width trait for doubles. More...
struct	PrecisionWidth< float >
	Precision width trait for floats. More...
Enumerations
enum	Alignment { NoAlign, LeftAlign, RightAlign, CentreAlign }
	Alignment tags for text formatting. More...
enum	FloatBase { Fixed, Sci }
	Base format tags for the float formatters. More...
enum	IntegralBase { Bin, Hex, Dec }
	Base format tags for the integral formatters. More...
Functions
template<typename OutputStream >
OutputStream &	operator<< (OutputStream &ostream, Format< std::string > &formatter) ecl_assert_throw_decl(StandardException)

---

Detailed Description

Embedded control libraries.

Various core libraries useful for embedded control systems.

---

Enumeration Type Documentation

enum ecl::Alignment

Alignment tags for text formatting.

Common alignment format tag for the formatters.

Enumerator:

NoAlign	No alignment used.
LeftAlign	Align to the left.
RightAlign	Align to the right.
CentreAlign	Align in the centre.

Definition at line 29 of file common.hpp.

enum ecl::FloatBase

Base format tags for the float formatters.

Base format tags for text formatting of floats.

Enumerator:

Fixed	Fixed formatting for floats (i.e. normal decimal representation).
Sci	Scientific formatting for floats (i.e. exponential representation).

Definition at line 33 of file floats.hpp.

enum ecl::IntegralBase

Base format tags for the integral formatters.

Format tags for text formatting of integral numbers.

Enumerator:

Bin	Binary representation for integral types.
Hex	Hex representation for integral types.
Dec	Decimal (i.e. normal) representation for integral types.

Definition at line 32 of file number.hpp.

---

Function Documentation

template<typename OutputStream >

OutputStream& ecl::operator<<	(	OutputStream &	ostream,
		Format< std::string > &	formatter
	)			[inline]

Insertion operator for formatters. It takes a customised formatter and inserts its current context into the stream. If two formatters are used in succession, it will throw an error (c++ cannot handle two in a single line of streaming). This works on normal c++ streams as well as TextStreams.

Parameters:

	ostream	: the stream to insert the formatted object into.
	formatter	: the format context.

Returns:

OutputStream : a handle to the resultant stream.

Exceptions:

StandardException

: throws if the formatter is used multiply in one stream operation [debug mode only].

Definition at line 222 of file strings.hpp.