Dev Essential
Loading...
Searching...
No Matches
ddl::dd::ArraySize Class Reference

#include <dd_common_types.h>

Public Member Functions

 ArraySize ()=default
 
 ArraySize (size_t array_size)
 
ArraySizeoperator= (size_t array_size)
 
 ArraySize (std::string array_size_element_name)
 
ArraySizeoperator= (const std::string &array_size_element_name)
 
void setArraySizeValue (size_t array_size)
 
size_t getArraySizeValue () const
 
void setArraySizeElementName (const std::string &array_size_element_name)
 
const std::string & getArraySizeElementName () const
 
bool isDynamicArraySize () const
 
bool operator== (const ArraySize &other) const
 
bool operator!= (const ArraySize &other) const
 

Detailed Description

Sinc DDL 2.0 it is possible to define arraysize with a string that indicates a dynamic array. The string it self is a elementname of the containing struct type.

Constructor & Destructor Documentation

◆ ArraySize() [1/3]

ddl::dd::ArraySize::ArraySize ( )
default

default CTOR.

◆ ArraySize() [2/3]

ddl::dd::ArraySize::ArraySize ( size_t array_size)

CTOR

Parameters
array_sizesets the array size

◆ ArraySize() [3/3]

ddl::dd::ArraySize::ArraySize ( std::string array_size_element_name)

CTOR

Parameters
array_size_element_namesets the dynamic array size elment name

Member Function Documentation

◆ getArraySizeElementName()

const std::string & ddl::dd::ArraySize::getArraySizeElementName ( ) const

gets the dynamic array size

Returns
std::string&

◆ getArraySizeValue()

size_t ddl::dd::ArraySize::getArraySizeValue ( ) const

get the array size

◆ isDynamicArraySize()

bool ddl::dd::ArraySize::isDynamicArraySize ( ) const

indicates if this is a dynamic erray size.

◆ operator!=()

bool ddl::dd::ArraySize::operator!= ( const ArraySize & other) const

compares the Array size with the other

Parameters
[other]the other array size
Return values
falseif they are equal
trueif they are not equal

◆ operator=() [1/2]

ArraySize & ddl::dd::ArraySize::operator= ( const std::string & array_size_element_name)

assignment operator

Parameters
array_size_element_namesets the dynamic array size elment name
Returns
ArraySize&

◆ operator=() [2/2]

ArraySize & ddl::dd::ArraySize::operator= ( size_t array_size)

assignment operator

Parameters
array_sizesets the array size
Returns
ArraySize&

◆ operator==()

bool ddl::dd::ArraySize::operator== ( const ArraySize & other) const

compares the Array size with the other

Parameters
[other]the other array size
Return values
trueif they are equal
falseif they are not equal

◆ setArraySizeElementName()

void ddl::dd::ArraySize::setArraySizeElementName ( const std::string & array_size_element_name)

sets the dynamic array size

Parameters
array_size_element_namesets the dynamic array size elment name

◆ setArraySizeValue()

void ddl::dd::ArraySize::setArraySizeValue ( size_t array_size)

set the array size

Parameters
array_sizesets the array size

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