OpenCurves  0.9
RealTimeSourceLoader Class Reference

Loads the XML specification files for RealTimeSource connections. More...

#include <realtimesourceloader.h>

Public Member Functions

RealTimeCommSpecload (const QString &fileName, QString *error=nullptr, int *errorLine=nullptr, int *errorColumn=nullptr)
 Attempt to load a real time source file. More...
 
RealTimeCommSpecparse (const QString &xmlString, QString *error=nullptr, int *errorLine=nullptr, int *errorColumn=nullptr)
 Attempt to parse an XML string for a real time source specification. More...
 

Detailed Description

Loads the XML specification files for RealTimeSource connections.

A description of the supported format can be found here.

Member Function Documentation

RealTimeCommSpec* RealTimeSourceLoader::load ( const QString &  fileName,
QString *  error = nullptr,
int *  errorLine = nullptr,
int *  errorColumn = nullptr 
)

Attempt to load a real time source file.

Parameters
fileNameThe name of the file to load.
errorUsed to return an error message (if provided).
errorLineUsed to indicate the line number for the error (if provided).
errorColumnUsed to indicate the column number for the error (if provided).
Returns
The RealTimeCommSpec loaded from the file on success, null on failure.
RealTimeCommSpec* RealTimeSourceLoader::parse ( const QString &  xmlString,
QString *  error = nullptr,
int *  errorLine = nullptr,
int *  errorColumn = nullptr 
)

Attempt to parse an XML string for a real time source specification.

Parameters
xmlStringXML formated text to parse.
errorUsed to return an error message (if provided).
errorLineUsed to indicate the line number for the error (if provided).
errorColumnUsed to indicate the column number for the error (if provided).
Returns
The parsed RealTimeCommSpec on success, null on failure.

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