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

Provide array information. More...

#include <ArrayDimension.hpp>

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

Public Member Functions

 ArrayDimension (void)=default
 Constructs an ArrayDimension instance.
 
 ArrayDimension (size_t count)
 Constructs an ArrayDimension instance.
 
 ArrayDimension (uint32 count, int32 offset)
 Constructs an ArrayDimension instance.
 
 ArrayDimension (const ArrayDimension &arg)=default
 Copy constructor.
 
 ArrayDimension (ArrayDimension &&arg) noexcept=default
 Move constructor.
 
ArrayDimensionoperator= (const ArrayDimension &arg)=default
 Copy assignment operator.
 
ArrayDimensionoperator= (ArrayDimension &&arg) noexcept=default
 Move assignment operator.
 
 ~ArrayDimension (void) noexcept=default
 Destructs this instance and frees all resources.
 
uint32 GetCount (void) const
 Get the number of array elements for this vector element. More...
 
int32 GetOffset (void) const
 Get the index offset of the array for this vector element 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 GetCacheSize (void)
 Get the cache size More...
 
static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Detailed Description

Provide array information.

Member Function Documentation

◆ Deserialize()

void Arp::Plc::Meta::Services::ArrayDimension::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::ArrayDimension::GetCacheSize ( void  )
static

Get the cache size

Returns
Number of using cache size

◆ GetCount()

uint32 Arp::Plc::Commons::Meta::ArrayDimension::GetCount ( void  ) const

Get the number of array elements for this vector element.

Returns
Number of array elements.

◆ GetFieldCount()

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

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ GetOffset()

int32 Arp::Plc::Commons::Meta::ArrayDimension::GetOffset ( void  ) const

Get the index offset of the array for this vector element

Returns
Array offset index.

◆ Serialize()

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