dxFeed .Net API  5.13.0
dxFeed .Net API library intended to provide market data access for DX clients
Public Member Functions | Private Attributes
com.dxfeed.ipf.InstrumentProfileWriter Class Reference

Writes instrument profiles to the stream using Simple File Format. Please see Instrument Profile Format documentation for complete description. This writer automatically derives data formats needed to write all meaningful fields. More...

Public Member Functions

 InstrumentProfileWriter ()
 Creates instrument profile writer. More...
 
void WriteToFile (string file, IList< InstrumentProfile > profiles)
 Writes specified instrument profiles into specified file. This method recognizes popular data compression formats "zip" and "gzip" by analysing file name. If file name ends with ".zip" then profiles will be written as a single compressed entry in a "zip" format. If file name ends with ".gz" then profiles will be compressed and written using "gzip" format. In other cases file will be considered uncompressed and profiles will be written as is. More...
 
void Write (Stream outStream, string name, IList< InstrumentProfile > profiles)
 Writes specified instrument profiles into specified stream using specified name to select data compression format. This method recognizes popular data compression formats "zip" and "gzip" by analysing file name. If file name ends with ".zip" then profiles will be written as a single compressed entry in a "zip" format. If file name ends with ".gz" then profiles will be compressed and written using "gzip" format. In other cases file will be considered uncompressed and profiles will be written as is. More...
 
void Write (Stream outStream, IList< InstrumentProfile > profiles)
 Writes specified instrument profiles into specified stream. More...
 

Private Attributes

const string FILE_EXTENSION = ".ipf"
 

Detailed Description

Writes instrument profiles to the stream using Simple File Format. Please see Instrument Profile Format documentation for complete description. This writer automatically derives data formats needed to write all meaningful fields.

Constructor & Destructor Documentation

◆ InstrumentProfileWriter()

com.dxfeed.ipf.InstrumentProfileWriter.InstrumentProfileWriter ( )
inline

Creates instrument profile writer.

Member Function Documentation

◆ Write() [1/2]

void com.dxfeed.ipf.InstrumentProfileWriter.Write ( Stream  outStream,
string  name,
IList< InstrumentProfile profiles 
)
inline

Writes specified instrument profiles into specified stream using specified name to select data compression format. This method recognizes popular data compression formats "zip" and "gzip" by analysing file name. If file name ends with ".zip" then profiles will be written as a single compressed entry in a "zip" format. If file name ends with ".gz" then profiles will be compressed and written using "gzip" format. In other cases file will be considered uncompressed and profiles will be written as is.

Parameters
outStreamWhere writes profiles.
nameName of output entry.
profilesParams list which will be written.
Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.
System.InvalidOperationExceptionCan't format certain profile.

◆ Write() [2/2]

void com.dxfeed.ipf.InstrumentProfileWriter.Write ( Stream  outStream,
IList< InstrumentProfile profiles 
)
inline

Writes specified instrument profiles into specified stream.

Parameters
outStreamWhere writes profiles.
profilesParams list which will be written.
Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.
System.InvalidOperationExceptionCan't format certain profile.

◆ WriteToFile()

void com.dxfeed.ipf.InstrumentProfileWriter.WriteToFile ( string  file,
IList< InstrumentProfile profiles 
)
inline

Writes specified instrument profiles into specified file. This method recognizes popular data compression formats "zip" and "gzip" by analysing file name. If file name ends with ".zip" then profiles will be written as a single compressed entry in a "zip" format. If file name ends with ".gz" then profiles will be compressed and written using "gzip" format. In other cases file will be considered uncompressed and profiles will be written as is.

Parameters
filePath to output file.
profilesParams list which will be written.
Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.
System.InvalidOperationExceptionCan't format certain profile.

Field Documentation

◆ FILE_EXTENSION

const string com.dxfeed.ipf.InstrumentProfileWriter.FILE_EXTENSION = ".ipf"
private

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