PLCnext API Documentation 26.0.1.58
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) noexcept=default
 Move constructor.
 
CustomAttributeoperator= (const CustomAttribute &arg)=default
 Copy assignment operator.
 
CustomAttributeoperator= (CustomAttribute &&arg) noexcept=default
 Move assignment operator
 
 ~CustomAttribute (void) noexcept=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
 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...
 

Detailed Description

Container for individual attributes within the interface DataBrowser

Member Function Documentation

◆ Deserialize()

void Arp::Plc::Meta::Services::CustomAttribute::Deserialize ( RscReader reader)

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

Parameters
readerReference to RscReader.

◆ GetCacheSize()

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

Get the cache size

Returns
Number of using cache size

◆ GetFieldCount()

size_t Arp::Plc::Meta::Services::CustomAttribute::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ GetName()

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

Name of the respective attribute this instance object include.

Returns
Attribute Name.

◆ GetValue()

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

Attribute value.

The value type is RscVariant.

Returns
RscVariant object.

◆ Serialize()

void Arp::Plc::Meta::Services::CustomAttribute::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: