OnixS C++ CME Audit Trail Generator  3.4.0
API documentation
AuditTrailGenerator Class Reference

#include <OnixS/CME/Trading/AuditTrailGenerator.h>

Public Member Functions

 AuditTrailGenerator (const FIX::Timestamp &cmeTradeDayStartTimeUtc, const std::string &outputFilenameExtension="csv", char outputFieldDelimiter= ';', const std::string &outputDirectory="")
 
 ~AuditTrailGenerator ()
 
void generate (const std::string &path)
 
void generate (const std::vector< std::string > &paths)
 
void generateForDirectory (const std::string &path)
 

Static Public Member Functions

static const std::string & version ()
 

Detailed Description

This class is designed to generate a complete and accurate record of all activity recorded in the OnixS FIX Engine .summary file.

Definition at line 32 of file AuditTrailGenerator.h.

Constructor & Destructor Documentation

AuditTrailGenerator ( const FIX::Timestamp &  cmeTradeDayStartTimeUtc,
const std::string &  outputFilenameExtension = "csv",
char  outputFieldDelimiter = ';',
const std::string &  outputDirectory = "" 
)

Constructor.

Parameters
cmeTradeDayStartTimeUtcCME trade day start time in UTC.
outputFilenameExtensionFilename extension for output file(s). Default value is "csv".
outputFieldDelimiterField delimiter for output file(s). Default value is ';'.
outputDirectoryA path to a directory where to save output files.

Destructor.

Member Function Documentation

void generate ( const std::string &  path)

Generates a report.

The report will be saved to the same path (if output directory is not specified) or to the output directory passed in constructor with the same name as a .summary file, but with the extension specified in the constructor.

Parameters
pathPath to a .summary file.
void generate ( const std::vector< std::string > &  paths)

Generates reports for the list of files.

Parameters
pathsList of paths to .summary files.
void generateForDirectory ( const std::string &  path)

Generates reports for all the .summary files the directory.

Parameters
pathPath to a directory.
static const std::string& version ( )
static

Version of audit trail generator.

Returns
version in format a.b.c.d.

The documentation for this class was generated from the following file: