| IOLink 1.11.0

Loading...
Searching...
No Matches
Public Member Functions | List of all members
iolink::Writer Class Referenceabstract

Interface to use in order to output a view to another medium. More...

`#include <iolink/writer/Writer.h>`

## Public Member Functions
virtual void | writeAll ()=0
| Output all the data.
virtual void | writeInit ()=0
| Initialize file and output only the header.
virtual void | writeData ()=0
| Output the data.
virtual void | writeFinish ()=0
| Write footer (if any) and finalize file.
virtual std::string | name () const =0
| Returns the name of the writer.
virtual std::string | version () const =0
| Returns the version of the writer.
virtual void | setOption (const std::string &parameter, std::shared_ptr< VariantDataValue > data)=0
| Set an option value to writer.
std::string | toString () const
| Return a string representation.

## Detailed Description

Interface to use in order to output a view to another medium.

## Member Function Documentation

## ◆ setOption()

virtual void iolink::Writer::setOption | ( | const std::string & | parameter,
|  | std::shared_ptr< VariantDataValue > | data
| ) |  |
| pure virtual

Set an option value to writer.

Parameters

  parameter | name of parameter whose value must be set
  data | value to set for the given parameter. Must be built with MetadataValue factory

Exceptions

  Error | if parameter is not known or given data is not valid

## ◆ writeData()

virtual void iolink::Writer::writeData | ( |  | ) |
| pure virtual

Output the data.

Should be called between writeInit() and writeFinish().

## ◆ writeFinish()

virtual void iolink::Writer::writeFinish | ( |  | ) |
| pure virtual

Write footer (if any) and finalize file.

Should be called after writeData().

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

- iolink/public/include/iolink/writer/Writer.h