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

This class represents the dimensions of an array More...

#include <ArrayDimension.hpp>

Public Member Functions

 ArrayDimension (uint32 count, int32 offset)
 Construct an ArrayDimension object More...
 
 ArrayDimension (const ArrayDimension &arg)
 The default copy constructor.
 
 ArrayDimension (ArrayDimension &&arg) noexcept
 The default move constructor.
 
ArrayDimensionoperator= (const ArrayDimension &arg)
 THe default copy-assignment operator.
 
ArrayDimensionoperator= (ArrayDimension &&arg) noexcept
 The default move-assignment operator.
 
 ~ArrayDimension (void)
 The default destructor.
 
uint32 GetCount () const
 Returns the number of elements in the array More...
 
int32 GetOffset () const
 Returns the offset of the first element More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Detailed Description

This class represents the dimensions of an array

Array dimensions are considered using count and offset to also support arrays that do not start at zero.

Constructor & Destructor Documentation

◆ ArrayDimension()

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

Construct an ArrayDimension object

Parameters
countNumber of elements in the array
offsetOffset of the first element, might be negative

Member Function Documentation

◆ GetCount()

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

Returns the number of elements in the array

Returns
Number of elements in the array

◆ GetOffset()

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

Returns the offset of the first element

Returns
Offset of the first element, might be negative

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