PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Base::Acf::Services::ComponentInfo Class Reference

Contains information about a component. More...

#include <ComponentInfo.hpp>

Inheritance diagram for Arp::Base::Acf::Services::ComponentInfo:
Inheritance graph

Public Member Functions

 ComponentInfo (void)
 Constructs an ComponentInfo instance.
 
 ComponentInfo (const RscString< 512 > &componentName, const RscString< 512 > &typeName, const RscString< 512 > &libraryName, const RscString< 128 > &processName, const RscString< 512 > &buildVersion, const RscString< 512 > &libraryVersion)
 Constructs an ComponentInfo 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

RscString< 512 > ComponentName
 Instance name of the component
 
RscString< 512 > TypeName
 C++ type name of the component
 
RscString< 512 > LibraryName
 Name of the library the component was created from
 
RscString< 128 > ProcessName
 Name of the process the component is created in
 
RscString< 512 > BuildVersion
 ArpVersion (incl. name and state) of the SDK used to compile the library
 
RscString< 512 > LibraryVersion
 ArpVersion (incl. name and state) provided by the author of the library
 

Detailed Description

Contains information about a component.

Member Function Documentation

◆ Deserialize()

void Arp::Base::Acf::Services::ComponentInfo::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::Base::Acf::Services::ComponentInfo::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

void Arp::Base::Acf::Services::ComponentInfo::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: