AuditTrailGenerator.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable OnixS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
 * part of this source code or associated reference material to any other location for further
 * reproduction or redistribution, and any amendments to this copyright notice, are expressly
 * prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */
#pragma once

#include <OnixS/CME/Trading/Export.h>
#include <OnixS/FIXEngine/FIX/Timestamp.h>

#include <string>
#include <vector>

namespace OnixS { namespace CME { namespace Trading {

/// This class is designed to generate a complete and accurate record
/// of all activity recorded in the OnixS FIX Engine .summary file.
class ONIXS_CME_ILINK2_AUDIT_TRAIL_GENERATOR_EXPORT AuditTrailGenerator
{
public:
    /// Constructor.
    ///
    /// \param cmeTradeDayStartTimeUtc CME trade day start time in UTC.
    /// \param outputFilenameExtension Filename extension for output file(s). Default value is
    /// "csv". \param outputFieldDelimiter Field delimiter for output file(s). Default value is ';'.
    /// \param outputDirectory A path to a directory where to save output files.
    AuditTrailGenerator(
        const FIX::Timestamp& cmeTradeDayStartTimeUtc,
        const std::string& outputFilenameExtension = "csv",
        char outputFieldDelimiter = ';',
        const std::string& outputDirectory = ""
    );

    /// Destructor.
    ~AuditTrailGenerator();

    /// 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.
    ///
    /// \param path Path to a `.summary` file.
    void generate(const std::string& path);

    /// Generates reports for the list of files.
    ///
    /// \param paths List of paths to `.summary` files.
    void generate(const std::vector<std::string>& paths);

    /// Generates reports for all the `.summary` files the directory.
    ///
    /// \param path Path to a directory.
    void generateForDirectory(const std::string& path);

    /// Version of audit trail generator.
    ///
    /// \return version in format a.b.c.d.
    static const std::string& version();

private:
    class Impl;
    Impl* impl_;
};

}}} // namespace OnixS::CME::Trading