format.h File Reference

Detailed Description

This file contains some general purpose string formatting functions.

#include "Cpl/Text/String.h"
#include "Cpl/System/ElapsedTime.h"
#include <stdlib.h>

Include dependency graph for format.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::Text
	The Text namespace provides yet-another String class and additional string and/or text processing utilities.

Functions
bool	Cpl::Text::bufferToString (const void *buffer, int len, Cpl::Text::String &destString, bool appendToString=false)
	This method will take a raw data buffer and convert it to an 'viewable' string.
bool	Cpl::Text::bufferToAsciiHex (const void *binaryData, int len, Cpl::Text::String &destString, bool upperCase=true, bool appendToString=false, char separator='\0')
	This method will convert a binary buffer to 'ASCII HEX', e.g.
bool	Cpl::Text::bufferToAsciiBinary (const void *binaryData, int len, Cpl::Text::String &destString, bool appendToString=false, bool reverse=false)
	This method converts the binary buffer to a single string that is ASCII BINARY.
bool	Cpl::Text::bufferToViewer (const void *binaryData, int len, Cpl::Text::String &destString, int bytesPerLine=16, const char *separator=" ", bool upperCase=true, bool appendToString=false)
	This method converts the binary buffer to a single string that is the ASCII HEX followed by 'separator', then by the binary data as 'viewable' text.
bool	Cpl::Text::formatMsecTimeStamp (Cpl::Text::String &buffer, unsigned long long timeStampInMsecs, bool encodeDay=true, bool appendToString=false)
	This method converts the binary millisecond count of 'timeStampInMsecs' to a string with the following format: "DD HH:MM:SS.SSS".
bool	Cpl::Text::formatSecTimeStamp (Cpl::Text::String &buffer, unsigned long long timeStampInSecs, bool encodeDay=true, bool appendToString=false)
	This method converts the binary second count of 'timeStampInSecs' to a string with the following format: "DD HH:MM:SS".
bool	Cpl::Text::formatPrecisionTimeStamp (Cpl::Text::String &buffer, Cpl::System::ElapsedTime::Precision_T timeStamp, bool encodeDay=true, bool appendToString=false)
	This method converts the Cpl::System::ElapsedTime::Precision_T value of time into a string with the following format: "DD HH:MM:SS.SSS".