Matrix Class Reference

The Matrix class. More...

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

+ Inheritance diagram for Matrix:

Public Member Functions

int getCols () const
 
type::matrix::ElementType getElementType () const
 
std::string getFullName () const override
 get the full name of this specific type More...
 
int getRows () const
 
std::string getShortName () const override
 get a short name of this specific type More...
 
 Matrix (const Path &path=Path())
 
 Matrix (const type::dto::Matrix &, const Path &path=Path())
 
void setCols (const int)
 
void setElementType (const type::matrix::ElementType)
 
void setRows (const int)
 
type::dto::MatrixPtr toMatrixDTO () const
 
- Public Member Functions inherited from NDArrayVariant< type::dto::Matrix, Matrix >
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::Matrix, Matrix >
type::Maybe getMaybe () const override
 get the maybe type More...
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative More...
 
 operator type::dto::Matrix ()
 
bool operator== (const Matrix &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::Matrix &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
 

Static Public Attributes

static const std::map< matrix::ElementType, std::string > Elementtype2String
 
static const std::map< std::string, matrix::ElementType > String2Elementtype
 

Additional Inherited Members

- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Static Public Member Functions inherited from SpecializedVariantBase< type::dto::Matrix, Matrix >
static const MatrixDynamicCast (const Variant &n)
 
static std::shared_ptr< MatrixDynamicCast (const VariantPtr &n)
 
static MatrixDynamicCast (Variant &n)
 
static std::shared_ptr< MatrixDynamicCastAndCheck (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::Matrix, Matrix >
type::dto::Matrix ::PointerType aron
 
- Protected Attributes inherited from Variant
const type::Descriptor descriptor
 
const Path path
 

Detailed Description

The Matrix class.

It represents the matrix type A Matrix is defined through the number of rows, cols and the element type

Definition at line 39 of file Matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

Matrix ( const Path path = Path())

Definition at line 47 of file Matrix.cpp.

◆ Matrix() [2/2]

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

Definition at line 52 of file Matrix.cpp.

Member Function Documentation

◆ getCols()

int getCols ( ) const

Definition at line 64 of file Matrix.cpp.

+ Here is the caller graph for this function:

◆ getElementType()

type::matrix::ElementType getElementType ( ) const

Definition at line 92 of file Matrix.cpp.

+ Here is the caller graph for this function:

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 117 of file Matrix.cpp.

+ Here is the call graph for this function:

◆ getRows()

int getRows ( ) const

Definition at line 58 of file Matrix.cpp.

+ Here is the caller graph for this function:

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 111 of file Matrix.cpp.

◆ setCols()

void setCols ( const int  h)

Definition at line 81 of file Matrix.cpp.

+ Here is the call graph for this function:

◆ setElementType()

void setElementType ( const type::matrix::ElementType  u)

Definition at line 98 of file Matrix.cpp.

◆ setRows()

void setRows ( const int  w)

Definition at line 70 of file Matrix.cpp.

+ Here is the call graph for this function:

◆ toMatrixDTO()

type::dto::MatrixPtr toMatrixDTO ( ) const

Definition at line 104 of file Matrix.cpp.

Member Data Documentation

◆ Elementtype2String

const std::map< matrix::ElementType, std::string > Elementtype2String
static
Initial value:
{
{matrix::ElementType::UINT8, "UINT8"},
{matrix::ElementType::UINT16, "UINT16"},
{matrix::ElementType::UINT32, "UINT32"},
{matrix::ElementType::INT8, "INT8"},
{matrix::ElementType::INT16, "INT16"},
{matrix::ElementType::INT32, "INT32"},
{matrix::ElementType::INT64, "INT64"},
{matrix::ElementType::FLOAT32, "FLOAT32"},
{matrix::ElementType::FLOAT64, "FLOAT64"}}

Definition at line 60 of file Matrix.h.

◆ String2Elementtype

const std::map< std::string, matrix::ElementType > String2Elementtype
static
Initial value:

Definition at line 61 of file Matrix.h.


The documentation for this class was generated from the following files:
armarx::aron::conversion::util::InvertMap
std::map< T2, T1 > InvertMap(const std::map< T1, T2 > &m)
Definition: Descriptor.h:42
armarx::aron::type::Matrix::Elementtype2String
static const std::map< matrix::ElementType, std::string > Elementtype2String
Definition: Matrix.h:60