PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::Io::Commons::Configuration::ITicSerializable Class Referenceabstract

Interface for all classes which should be serializable from and to Tic doccuments. More...

#include <ITicSerializable.hpp>

Inheritance diagram for Arp::Io::Commons::Configuration::ITicSerializable:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< ITicSerializable >
 

Public Member Functions

 ITicSerializable (void)=default
 Constructs an ITicSerializable instance.
 
 ITicSerializable (const ITicSerializable &arg)=default
 Copy constructor.
 
 ITicSerializable (ITicSerializable &&arg) noexcept=default
 Move constructor.
 
ITicSerializableoperator= (const ITicSerializable &arg)=default
 Copy-assignment operator.
 
ITicSerializableoperator= (ITicSerializable &&arg) noexcept=default
 Move-assignment operator.
 
virtual ~ITicSerializable (void)=default
 Destructs this instance and frees all resources.
 
virtual void ReadTic (TicReader &reader)=0
 This operation shall be implemented to read the content from Tic documents. More...
 
virtual void WriteTic (TicWriter &writer)=0
 This operation shall be implemented to write the content to Tic documents. More...
 

Detailed Description

Interface for all classes which should be serializable from and to Tic doccuments.

Member Function Documentation

◆ ReadTic()

virtual void Arp::Io::Commons::Configuration::ITicSerializable::ReadTic ( TicReader reader)
pure virtual

This operation shall be implemented to read the content from Tic documents.

Parameters
readerThe TicReader to read the TIC content from.

Implemented in Arp::Io::Commons::Configuration::TicBase.

◆ WriteTic()

virtual void Arp::Io::Commons::Configuration::ITicSerializable::WriteTic ( TicWriter &  writer)
pure virtual

This operation shall be implemented to write the content to Tic documents.

Parameters
writerThe TicWriter to write the TIC content to.

This operation is currently not supported.

Implemented in Arp::Io::Commons::Configuration::TicBase.


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