PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::System::Commons::Services::Io::ReadFileData Class Reference

Contains output information and data of a file to read More...

#include <ReadFileData.hpp>

Inheritance diagram for Arp::System::Commons::Services::Io::ReadFileData:
Inheritance graph

Public Member Functions

 ReadFileData (void)
 Constructs an ReadFileData instance.
 
 ReadFileData (FileSystemError result, const std::vector< TraitItem > &traitItems, RscStream data)
 Constructs an ReadFileData instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

FileSystemError Result = static_cast<FileSystemError>(0)
 Contains an error code as a result of the read process
 
std::vector< TraitItemTraitItems
 Contains the requested traits of the file to read
 
RscStream Data
 Contains the data of the file to read
 

Detailed Description

Contains output information and data of a file to read

Member Function Documentation

◆ Deserialize()

void Arp::System::Commons::Services::Io::ReadFileData::Deserialize ( RscReader reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::System::Commons::Services::Io::ReadFileData::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

void Arp::System::Commons::Services::Io::ReadFileData::Serialize ( RscWriter writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

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