QuantConnect.ToolBox.RawFileProcessor Class Reference

Processing harness used to read files in, parse them, and process them. More...

Inheritance diagram for QuantConnect.ToolBox.RawFileProcessor:

Public Member Functions
	RawFileProcessor (IStreamProvider streamProvider, IStreamParser parser, params IDataProcessor[] processors)
	Initializes a new instance of the RawFileProcessor class More...
void	Process (string source)
	Perform processing on the specified source file More...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static bool	Run (string name, IEnumerable< string > sources, IStreamProvider streamProvider, IStreamParser streamParser, params IDataProcessor[] processors)
	Runs the raw file processor on the specified files More...

Properties
string	Name [get, set]
	Gets or sets a name used for logging More...

Detailed Description

Processing harness used to read files in, parse them, and process them.

Definition at line 27 of file RawFileProcessor.cs.

Constructor & Destructor Documentation

RawFileProcessor()

QuantConnect.ToolBox.RawFileProcessor.RawFileProcessor	(	IStreamProvider	streamProvider,
		IStreamParser	parser,
		params IDataProcessor[]	processors
	)

Initializes a new instance of the RawFileProcessor class

Definition at line 42 of file RawFileProcessor.cs.

Here is the caller graph for this function:

Member Function Documentation

Run()

static bool QuantConnect.ToolBox.RawFileProcessor.Run ( string  name, IEnumerable< string >  sources, IStreamProvider  streamProvider, IStreamParser  streamParser, params IDataProcessor[]  processors  )

static

Runs the raw file processor on the specified files

Parameters

name	A name for the processor used for logging
sources	The raw files to be processed
streamProvider	Instance capable of reading the sources into a stream
streamParser	Instance capable of parsing the provided stream
processors	The data processors to process the parsed data

Returns

True if the operation completed without error, otherwise false

Definition at line 58 of file RawFileProcessor.cs.

Here is the call graph for this function:

Process()

void QuantConnect.ToolBox.RawFileProcessor.Process

(

string

source

)

Perform processing on the specified source file

Parameters

source

The source file to be processed

Definition at line 82 of file RawFileProcessor.cs.

Here is the call graph for this function:

Dispose()

void QuantConnect.ToolBox.RawFileProcessor.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 108 of file RawFileProcessor.cs.

Here is the call graph for this function:

Property Documentation

Name

string QuantConnect.ToolBox.RawFileProcessor.Name

getset

Gets or sets a name used for logging

Definition at line 37 of file RawFileProcessor.cs.

---

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

• ToolBox/RawFileProcessor.cs