PLCnext API Documentation  21.0.0.35466
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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. More...
 
 CustomAttribute (const String &name, RscVariant< 256 > value)
 Constructs an CustomAttribute instance. More...
 
 CustomAttribute (const CustomAttribute &arg)=default
 Copy constructor. More...
 
 CustomAttribute (CustomAttribute &&arg)=default
 Move constructor. More...
 
CustomAttributeoperator= (const CustomAttribute &arg)=default
 Copy assignment operator. More...
 
CustomAttributeoperator= (CustomAttribute &&arg)=default
 Move assignment operator More...
 
 ~CustomAttribute (void)=default
 Destructs this instance and frees all resources. More...
 
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 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

Constructor & Destructor Documentation

◆ CustomAttribute() [1/4]

Arp::Plc::Commons::Meta::CustomAttribute::CustomAttribute ( void  )
default

Constructs an CustomAttribute instance.

◆ CustomAttribute() [2/4]

Arp::Plc::Commons::Meta::CustomAttribute::CustomAttribute ( const String name,
RscVariant< 256 >  value 
)

Constructs an CustomAttribute instance.

◆ CustomAttribute() [3/4]

Arp::Plc::Commons::Meta::CustomAttribute::CustomAttribute ( const CustomAttribute arg)
default

Copy constructor.

◆ CustomAttribute() [4/4]

Arp::Plc::Commons::Meta::CustomAttribute::CustomAttribute ( CustomAttribute &&  arg)
default

Move constructor.

◆ ~CustomAttribute()

Arp::Plc::Commons::Meta::CustomAttribute::~CustomAttribute ( void  )
default

Destructs this instance and frees all resources.

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.

◆ operator=() [1/2]

CustomAttribute& Arp::Plc::Commons::Meta::CustomAttribute::operator= ( const CustomAttribute arg)
default

Copy assignment operator.

◆ operator=() [2/2]

CustomAttribute& Arp::Plc::Commons::Meta::CustomAttribute::operator= ( CustomAttribute &&  arg)
default

Move assignment operator

◆ 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: