NDArray Class Reference

The NDArray class. More...

#include <RobotAPI/libraries/aron/core/type/variant/ndarray/NDArray.h>

+ Inheritance diagram for NDArray:

Public Member Functions

void addDimension ()
 
type::ndarray::ElementType getElementType () const
 
std::string getFullName () const override
 get the full name of this specific type More...
 
int getNumberDimensions () const
 
std::string getShortName () const override
 get a short name of this specific type More...
 
 NDArray (const Path &path=Path())
 
 NDArray (const type::dto::NDArray &, const Path &path=Path())
 
void setElementType (type::ndarray::ElementType)
 
void setNumberDimensions (int)
 
type::dto::NDArrayPtr toNDArrayDTO () const
 
- Public Member Functions inherited from NDArrayVariant< type::dto::NDArray, NDArray >
size_t childrenSize () const override
 
std::vector< VariantPtrgetChildren () const override
 get all child elements More...
 
std::string getDefaultValue () const
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute More...
 
void setDefaultValue (const std::string &v)
 
virtual ~NDArrayVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< type::dto::NDArray, NDArray >
type::Maybe getMaybe () const override
 get the maybe type More...
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative More...
 
 operator type::dto::NDArray ()
 
bool operator== (const NDArray &other) const
 
bool operator== (const Variant &other) const override
 
void setMaybe (const type::Maybe m) override
 set the maybetype of this type More...
 
 SpecializedVariantBase (const type::Descriptor &descriptor, const Path &path)
 
 SpecializedVariantBase (const type::dto::NDArray &o, const type::Descriptor &descriptor, const Path &path)
 
type::dto::GenericTypePtr toAronDTO () const override
 convert this variant to a dto object. More...
 
virtual ~SpecializedVariantBase ()=default
 
- Public Member Functions inherited from Variant
virtual size_t childrenSize () const =0
 
virtual std::vector< VariantPtrgetChildren () const =0
 get all child elements More...
 
type::Descriptor getDescriptor () const
 
virtual type::Maybe getMaybe () const =0
 get the maybe type More...
 
Path getPath () const
 
bool operator== (const VariantPtr &other) const
 
std::string pathToString () const
 
virtual type::dto::GenericTypePtr toAronDTO () const =0
 convert this variant to a dto object. More...
 
 Variant (const type::Descriptor &descriptor, const Path &path=Path())
 
virtual ~Variant ()=default
 

Additional Inherited Members

- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Static Public Member Functions inherited from SpecializedVariantBase< type::dto::NDArray, NDArray >
static const NDArrayDynamicCast (const Variant &n)
 
static std::shared_ptr< NDArrayDynamicCast (const VariantPtr &n)
 
static NDArrayDynamicCast (Variant &n)
 
static std::shared_ptr< NDArrayDynamicCastAndCheck (const VariantPtr &n)
 
- Static Public Member Functions inherited from Variant
static VariantPtr FromAronDTO (const type::dto::GenericType &, const Path &=Path())
 create a variant object from an dto object More...
 
- Protected Attributes inherited from SpecializedVariantBase< type::dto::NDArray, NDArray >
type::dto::NDArray ::PointerType aron
 
- Protected Attributes inherited from Variant
const type::Descriptor descriptor
 
const Path path
 

Detailed Description

The NDArray class.

It represents an arbitrary array type

Definition at line 38 of file NDArray.h.

Constructor & Destructor Documentation

◆ NDArray() [1/2]

NDArray ( const Path path = Path())

Definition at line 30 of file NDArray.cpp.

◆ NDArray() [2/2]

NDArray ( const type::dto::NDArray &  o,
const Path path = Path() 
)

Definition at line 35 of file NDArray.cpp.

Member Function Documentation

◆ addDimension()

void addDimension ( )

Definition at line 71 of file NDArray.cpp.

◆ getElementType()

type::ndarray::ElementType getElementType ( ) const

Definition at line 53 of file NDArray.cpp.

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 84 of file NDArray.cpp.

◆ getNumberDimensions()

int getNumberDimensions ( ) const

Definition at line 47 of file NDArray.cpp.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 78 of file NDArray.cpp.

◆ setElementType()

void setElementType ( type::ndarray::ElementType  s)

Definition at line 59 of file NDArray.cpp.

+ Here is the call graph for this function:

◆ setNumberDimensions()

void setNumberDimensions ( int  v)

Definition at line 65 of file NDArray.cpp.

+ Here is the call graph for this function:

◆ toNDArrayDTO()

type::dto::NDArrayPtr toNDArrayDTO ( ) const

Definition at line 41 of file NDArray.cpp.


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