| IOLink 1.11.0

Loading...
Searching...
No Matches
Writer.h
1#pragma once
2
3#include <iolink/IOLinkAPI.h>
4#include <iolink/VariantDataValue.h>
5
6 namespace iolink
7{
8
12 class IOLINK_API Writer
13{
14 public:
15 virtual ~Writer() = default;
16
20 virtual void writeAll() = 0;
21
25 virtual void writeInit() = 0;
26
30 virtual void writeData() = 0;
31
35 virtual void writeFinish() = 0;
36
40 virtual std::string name() const = 0;
41
45 virtual std::string version() const = 0;
46
55 virtual void setOption(const std::string& parameter, std::shared_ptr<VariantDataValue> data) = 0;
56
60 std::string toString() const;
61};
62
63} // end namespace iolink
iolink::Writer
Interface to use in order to output a view to another medium.
Definition Writer.h:13
iolink::Writer::toString
std::string toString() const
Return a string representation.
iolink::Writer::version
virtual std::string version() const =0
Returns the version of the writer.
iolink::Writer::writeFinish
virtual void writeFinish()=0
Write footer (if any) and finalize file.
iolink::Writer::writeAll
virtual void writeAll()=0
Output all the data.
iolink::Writer::name
virtual std::string name() const =0
Returns the name of the writer.
iolink::Writer::writeInit
virtual void writeInit()=0
Initialize file and output only the header.
iolink::Writer::setOption
virtual void setOption(const std::string &parameter, std::shared_ptr< VariantDataValue > data)=0
Set an option value to writer.
iolink::Writer::writeData
virtual void writeData()=0
Output the data.
iolink
All IOLink symbols are enclosed in this namespace.
Definition ArrayX.h:8