diff --git a/doc/html/annotated.html b/doc/html/annotated.html deleted file mode 100644 index fa4b211..0000000 --- a/doc/html/annotated.html +++ /dev/null @@ -1,118 +0,0 @@ - - -
- - - -
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
▼NApplicationUtilities | Contains currently only ArgumentParser and related classes |
CArgument | Wrapper for command line argument information |
CArgumentParser | Means for handling command line arguments |
CFailure | The exception that is thrown by an ArgumentParser when a parsing error occurs |
▼NChronoUtilities | Contains classes providing a means for handling date and time information |
CDateTime | Represents an instant in time, typically expressed as a date and time of day |
CPeriod | Represents a period of time |
CTimeSpan | Represents a time interval |
▼NConversionUtilities | Contains several functions providing conversions between different data types |
CConversionException | The exception that is thrown when an conversion error occurs |
CWiden | Converts a std::string to std::wstring |
▼NIoUtilities | Contains utility classes helping to read and write streams |
CBinaryReader | Reads primitive data types from a std::istream using a specified ConversionUtilities::ByteOrder |
CBinaryWriter | Writes primitive data types to a std::ostream using a specified ConversionUtilities::ByteOrder |
CCopyHelper | The copy helper class helps to copy bytes from one stream to another |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
#include "argumentparser.h"
#include "failure.h"
#include "../conversion/stringconversion.h"
#include <algorithm>
#include <vector>
#include <iostream>
#include <sstream>
#include <stdexcept>
Go to the source code of this file.
--Namespaces | |
ApplicationUtilities | |
Contains currently only ArgumentParser and related classes. | |
-Functions | |
Argument * | ApplicationUtilities::firstPresentUncombinableArg (const ArgumentVector &args, const Argument *except) |
This function return the first present and uncombinable argument of the given list of arguments. More... | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
#include "global.h"
#include <string>
#include <vector>
#include <list>
#include <initializer_list>
#include <functional>
#include <stdexcept>
Go to the source code of this file.
--Classes | |
class | ApplicationUtilities::Argument |
The Argument class is a wrapper for command line argument information. More... | |
class | ApplicationUtilities::ArgumentParser |
The ArgumentParser class provides a means for handling command line arguments. More... | |
-Namespaces | |
ApplicationUtilities | |
Contains currently only ArgumentParser and related classes. | |
-Typedefs | |
typedef std::initializer_list -< Argument * > | ApplicationUtilities::ArgumentInitializerList |
typedef std::vector< Argument * > | ApplicationUtilities::ArgumentVector |
typedef std::vector< std::string > | ApplicationUtilities::StringVector |
typedef std::list< std::string > | ApplicationUtilities::StringList |
typedef std::function< bool(Argument *)> | ApplicationUtilities::ArgumentPredicate |
-Functions | |
Argument * | ApplicationUtilities::firstPresentUncombinableArg (const ArgumentVector &args, const Argument *except) |
This function return the first present and uncombinable argument of the given list of arguments. More... | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
Go to the source code of this file.
--Namespaces | |
ConversionUtilities | |
Contains several functions providing conversions between different data types. | |
-Functions | |
int16 | ConversionUtilities::toInt16 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 16-bit signed integer converted from two bytes at a specified position in a char array. More... | |
uint16 | ConversionUtilities::toUInt16 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 16-bit unsigned integer converted from two bytes at a specified position in a char array. More... | |
int32 | ConversionUtilities::toInt32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit signed integer converted from four bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toUInt24 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit unsigned integer converted from three bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toUInt32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit unsigned integer converted from four bytes at a specified position in a char array. More... | |
int64 | ConversionUtilities::toInt64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit signed integer converted from eight bytes at a specified position in a char array. More... | |
uint64 | ConversionUtilities::toUInt64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a char array. More... | |
float32 | ConversionUtilities::toFloat32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit floating point number converted from four bytes at a specified position in a char array. More... | |
float64 | ConversionUtilities::toFloat64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit floating point number converted from eight bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toSynchsafeInt (uint32 normalInt) |
Returns a 32-bit synchsafe integer converted from a normal 32-bit integer. More... | |
uint32 | ConversionUtilities::toNormalInt (uint32 synchsafeInt) |
Returns a normal 32-bit integer converted from a 32-bit synchsafe integer. More... | |
void | ConversionUtilities::getBytes (int16 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 16-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint16 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 16-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (int32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (int64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (float32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit floating point value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (float64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit floating point value at a specified position in a char array. More... | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
Go to the source code of this file.
--Namespaces | |
ConversionUtilities | |
Contains several functions providing conversions between different data types. | |
-Enumerations | |
enum | ConversionUtilities::ByteOrder { ConversionUtilities::ByteOrder::BigEndian, -ConversionUtilities::ByteOrder::LittleEndian - } |
Specifies the byte order/endianness. More... | |
-Functions | |
int16 | ConversionUtilities::toInt16 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 16-bit signed integer converted from two bytes at a specified position in a char array. More... | |
uint16 | ConversionUtilities::toUInt16 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 16-bit unsigned integer converted from two bytes at a specified position in a char array. More... | |
int32 | ConversionUtilities::toInt32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit signed integer converted from four bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toUInt24 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit unsigned integer converted from three bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toUInt32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit unsigned integer converted from four bytes at a specified position in a char array. More... | |
int64 | ConversionUtilities::toInt64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit signed integer converted from eight bytes at a specified position in a char array. More... | |
uint64 | ConversionUtilities::toUInt64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a char array. More... | |
float32 | ConversionUtilities::toFloat32 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 32-bit floating point number converted from four bytes at a specified position in a char array. More... | |
float64 | ConversionUtilities::toFloat64 (const char *value, int startIndex, ByteOrder byteOrder) |
Returns a 64-bit floating point number converted from eight bytes at a specified position in a char array. More... | |
uint32 | ConversionUtilities::toSynchsafeInt (uint32 normalInt) |
Returns a 32-bit synchsafe integer converted from a normal 32-bit integer. More... | |
uint32 | ConversionUtilities::toNormalInt (uint32 synchsafeInt) |
Returns a normal 32-bit integer converted from a 32-bit synchsafe integer. More... | |
void | ConversionUtilities::getBytes (int16 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 16-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint16 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 16-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (int32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (int64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit signed integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (uint64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit unsigned integer value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (float32 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 32-bit floating point value at a specified position in a char array. More... | |
void | ConversionUtilities::getBytes (float64 value, char *outputbuffer, int startIndex, ByteOrder byteOrder) |
Stores the specified 64-bit floating point value at a specified position in a char array. More... | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
#include "binaryreader.h"
#include <conversion/conversionexception.h>
#include <sstream>
#include <memory>
Go to the source code of this file.
--Namespaces | |
IoUtilities | |
Contains utility classes helping to read and write streams. | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
#include "../application/global.h"
#include "../conversion/types.h"
#include "../conversion/binaryconversion.h"
#include <vector>
#include <string>
#include <istream>
Go to the source code of this file.
--Classes | |
class | IoUtilities::BinaryReader |
Reads primitive data types from a std::istream using a specified ConversionUtilities::ByteOrder. More... | |
-Namespaces | |
IoUtilities | |
Contains utility classes helping to read and write streams. | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
#include "binarywriter.h"
#include "../conversion/conversionexception.h"
#include <cstring>
#include <memory>
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
| BinaryWriter (IoUtilities) |
|
| ||||
| |||||||
Argument (ApplicationUtilities) | Failure (ApplicationUtilities) | TimeSpan (ChronoUtilities) | |||||
ArgumentParser (ApplicationUtilities) | ConversionException (ConversionUtilities) |
|
| ||||
| CopyHelper (IoUtilities) | ||||||
| Period (ChronoUtilities) | Widen (ConversionUtilities) | |||||
BinaryReader (IoUtilities) | |||||||
DateTime (ChronoUtilities) | |||||||
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
Go to the source code of this file.
--Classes | |
class | ChronoUtilities::DateTime |
Represents an instant in time, typically expressed as a date and time of day. More... | |
-Namespaces | |
ChronoUtilities | |
Contains classes providing a means for handling date and time information. | |
-Enumerations | |
enum | ChronoUtilities::DateTimeOutputFormat { - ChronoUtilities::DateTimeOutputFormat::DateAndTime, -ChronoUtilities::DateTimeOutputFormat::DateOnly, -ChronoUtilities::DateTimeOutputFormat::TimeOnly, -ChronoUtilities::DateTimeOutputFormat::DateTimeAndWeekday, - - ChronoUtilities::DateTimeOutputFormat::DateTimeAndShortWeekday - - } |
Specifies the output format. More... | |
enum | ChronoUtilities::DayOfWeek { - ChronoUtilities::DayOfWeek::Monday, -ChronoUtilities::DayOfWeek::Tuesday, -ChronoUtilities::DayOfWeek::Wednesday, -ChronoUtilities::DayOfWeek::Thursday, - - ChronoUtilities::DayOfWeek::Friday, -ChronoUtilities::DayOfWeek::Saturday, -ChronoUtilities::DayOfWeek::Sunday - - } |
Specifies the day of the week. More... | |
enum | ChronoUtilities::DatePart { ChronoUtilities::DatePart::Year, -ChronoUtilities::DatePart::Month, -ChronoUtilities::DatePart::DayOfYear, -ChronoUtilities::DatePart::Day - } |
Specifies the date part. More... | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
File in application | Includes file in conversion |
---|---|
argumentparser.cpp | stringconversion.h |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
File in chrono | Includes file in application |
---|---|
period.h | global.h |
timespan.h | global.h |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
File in chrono | Includes file in conversion |
---|---|
datetime.cpp | stringconversion.h |
datetime.h | types.h |
timespan.cpp | stringconversion.h |
timespan.h | types.h |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
File in conversion | Includes file in application |
---|---|
binaryconversion.h | global.h |
conversionexception.h | global.h |
widen.h | global.h |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
File in io | Includes file in application |
---|---|
binaryreader.h | global.h |
binarywriter.h | global.h |
copy.h | global.h |
path.cpp | global.h |
path.h | global.h |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
-Files | |
file | misc.cpp [code] |
file | misc.h [code] |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
This page explains how to interpret the graphs that are generated by doxygen.
-Consider the following example:
This will result in the following graph:
-The boxes in the above graph have the following meaning:
-The arrows have the following meaning:
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
CApplicationUtilities::Argument | Wrapper for command line argument information |
CApplicationUtilities::ArgumentParser | Means for handling command line arguments |
CIoUtilities::BinaryReader | Reads primitive data types from a std::istream using a specified ConversionUtilities::ByteOrder |
CIoUtilities::BinaryWriter | Writes primitive data types to a std::ostream using a specified ConversionUtilities::ByteOrder |
CIoUtilities::CopyHelper< bufferSize > | The copy helper class helps to copy bytes from one stream to another |
CChronoUtilities::DateTime | Represents an instant in time, typically expressed as a date and time of day |
▼Cstd::exception | STL class |
CApplicationUtilities::Failure | The exception that is thrown by an ArgumentParser when a parsing error occurs |
▼Cstd::runtime_error | STL class |
CConversionUtilities::ConversionException | The exception that is thrown when an conversion error occurs |
CChronoUtilities::Period | Represents a period of time |
CChronoUtilities::TimeSpan | Represents a time interval |
▼Cunary_function | |
CConversionUtilities::Widen< E, T, A > | Converts a std::string to std::wstring |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
- |
- |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-
Go to the source code of this file.
--Namespaces | |
MathUtilities | |
Contains various mathematical functions. | |
- Utilities
- 1
-
- Collection of utility classes and functions used by my C++ applications.
- |
-