PLCnext API Documentation  20.0.0.24462
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::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. More...
 
 ArrayDimension (size_t count)
 Constructs an ArrayDimension instance. More...
 
 ArrayDimension (uint32 count, int32 offset)
 Constructs an ArrayDimension instance. More...
 
 ArrayDimension (const ArrayDimension &arg)=default
 Copy constructor. More...
 
 ArrayDimension (ArrayDimension &&arg)=default
 Move constructor. More...
 
ArrayDimensionoperator= (const ArrayDimension &arg)=default
 Copy assignment operator. More...
 
ArrayDimensionoperator= (ArrayDimension &&arg)=default
 Move assignment operator. More...
 
 ~ArrayDimension (void)=default
 Destructs this instance and frees all resources. More...
 
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 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 GetCacheSize (void)
 Get the cache size More...
 
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

Provide array information.

Constructor & Destructor Documentation

◆ ArrayDimension() [1/5]

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

Constructs an ArrayDimension instance.

◆ ArrayDimension() [2/5]

Arp::Plc::Commons::Meta::ArrayDimension::ArrayDimension ( size_t  count)
explicit

Constructs an ArrayDimension instance.

◆ ArrayDimension() [3/5]

Arp::Plc::Commons::Meta::ArrayDimension::ArrayDimension ( uint32  count,
int32  offset 
)

Constructs an ArrayDimension instance.

◆ ArrayDimension() [4/5]

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

Copy constructor.

◆ ArrayDimension() [5/5]

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

Move constructor.

◆ ~ArrayDimension()

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

Destructs this instance and frees all resources.

Member Function Documentation

◆ Deserialize()

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

Get the cache size

Returns
Number of using cache size

◆ GetCount()

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

Get the number of array elements for this vector element.

Returns
Number of array elements.

◆ GetOffset()

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

Get the index offset of the array for this vector element

Returns
Array offset index.

◆ operator=() [1/2]

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

Copy assignment operator.

◆ operator=() [2/2]

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

Move assignment operator.

◆ Serialize()

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