PLCnext API Documentation 23.6.0.37
Public Member Functions | Static Public Member Functions | List of all members
Arp::Plc::Commons::Meta::CustomAttribute Class Reference

Container for individual attributes within the interface DataBrowser More...

#include <CustomAttribute.hpp>

Inheritance diagram for Arp::Plc::Commons::Meta::CustomAttribute:
Inheritance graph

Public Member Functions

 CustomAttribute (void)=default
 Constructs an CustomAttribute instance.
 
 CustomAttribute (const String &name, RscVariant< 256 > value)
 Constructs an CustomAttribute instance.
 
 CustomAttribute (const CustomAttribute &arg)=default
 Copy constructor.
 
 CustomAttribute (CustomAttribute &&arg)=default
 Move constructor.
 
CustomAttributeoperator= (const CustomAttribute &arg)=default
 Copy assignment operator.
 
CustomAttributeoperator= (CustomAttribute &&arg)=default
 Move assignment operator
 
 ~CustomAttribute (void) override=default
 Destructs this instance and frees all resources.
 
const StringGetName () const
 Name of the respective attribute this instance object include. More...
 
const RscVariant< 256 > & GetValue () const
 Attribute value. More...
 
size_t GetCacheSize (void) const
 Get the cache size More...
 
void Serialize (RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor
 
virtual void Serialize (RscWriter &writer) const =0
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
virtual void Deserialize (RscReader &reader)=0
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 

Static Public Member Functions

static size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Detailed Description

Container for individual attributes within the interface DataBrowser

Member Function Documentation

◆ Deserialize()

void Arp::Plc::Commons::Meta::CustomAttribute::Deserialize ( RscReader reader)
overridevirtual

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

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ GetCacheSize()

size_t Arp::Plc::Commons::Meta::CustomAttribute::GetCacheSize ( void  ) const
inline

Get the cache size

Returns
Number of using cache size

◆ GetName()

const String & Arp::Plc::Commons::Meta::CustomAttribute::GetName ( void  ) const
inline

Name of the respective attribute this instance object include.

Returns
Attribute Name.

◆ GetValue()

const RscVariant< 256 > & Arp::Plc::Commons::Meta::CustomAttribute::GetValue ( void  ) const
inline

Attribute value.

The value type is RscVariant.

Returns
RscVariant object.

◆ Serialize()

void Arp::Plc::Commons::Meta::CustomAttribute::Serialize ( RscWriter writer) const
overridevirtual

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

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.


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