Arp::Plc::Commons::Meta::ArrayDimensions Class Reference

Provide array information. More...

#include <ArrayDimensions.hpp>

Public Types
using	Values = std::vector< ArrayDimension >

Public Member Functions
	ArrayDimensions (void)=default
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (size_t count)
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (const ArrayDimension &entry)
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (const Values &values)
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (const std::initializer_list< int > &dimensions)
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (const std::initializer_list< ArrayDimension > &entries)
	Constructs an ArrayDimension instance. More...
	ArrayDimensions (const ArrayDimensions &arg)=default
	Copy constructor. More...
	ArrayDimensions (ArrayDimensions &&arg)=default
	Move constructor. More...
ArrayDimensions &	operator= (const ArrayDimensions &arg)=default
	Copy assignment operator. More...
ArrayDimensions &	operator= (ArrayDimensions &&arg)=default
	Move assignment operator. More...
	~ArrayDimensions (void)=default
	Destructs this instance and frees all resources. More...
ArrayDimension &	operator[] (size_t index)
const ArrayDimension &	operator[] (size_t index) const
bool	IsEmpty (void) const
size_t	GetCount (void) const
	Get the number of array dimensions for this vector element. More...
const Values &	GetValues (void) const
size_t	GetCacheSize (void) const
	Get the cache size More...
size_t	GetDimensionsProduct (void) const
	Gets the element count total. More...
void	Append (const ArrayDimension &dimension)

Static Public Attributes
static const ArrayDimensions	Empty

Protected Member Functions
void	EraseFrontDimension (void)

Friends
class	ArrayNavigator

Detailed Description

Provide array information.

Constructor & Destructor Documentation

ArrayDimensions() [1/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( void  )

default

Constructs an ArrayDimension instance.

ArrayDimensions() [2/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( size_t  count )

inlineexplicit

Constructs an ArrayDimension instance.

ArrayDimensions() [3/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( const ArrayDimension &  entry )

inline

Constructs an ArrayDimension instance.

ArrayDimensions() [4/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( const Values &  values )

inline

Constructs an ArrayDimension instance.

ArrayDimensions() [5/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions

(

const std::initializer_list< int > &

dimensions

)

Constructs an ArrayDimension instance.

ArrayDimensions() [6/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions

(

const std::initializer_list< ArrayDimension > &

entries

)

Constructs an ArrayDimension instance.

ArrayDimensions() [7/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( const ArrayDimensions &  arg )

default

Copy constructor.

ArrayDimensions() [8/8]

Arp::Plc::Commons::Meta::ArrayDimensions::ArrayDimensions ( ArrayDimensions &&  arg )

default

Move constructor.

~ArrayDimensions()

Arp::Plc::Commons::Meta::ArrayDimensions::~ArrayDimensions ( void  )

default

Destructs this instance and frees all resources.

Member Function Documentation

GetCacheSize()

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

inline

Get the cache size

Returns

Number of using cache size

GetCount()

size_t Arp::Plc::Commons::Meta::ArrayDimensions::GetCount ( void  ) const

inline

Get the number of array dimensions for this vector element.

Returns

Number of array dimensions.

GetDimensionsProduct()

size_t Arp::Plc::Commons::Meta::ArrayDimensions::GetDimensionsProduct

(

void

)

const

Gets the element count total.

Returns

Inner product of all dimensions which is the total of all elements in the array.

operator=() [1/2]

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

default

Copy assignment operator.

operator=() [2/2]

ArrayDimensions& Arp::Plc::Commons::Meta::ArrayDimensions::operator= ( ArrayDimensions &&  arg )

default

Move assignment operator.

---

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

• Arp/Plc/Commons/Meta/ArrayDimensions.hpp