List of all members | Public Member Functions | Static Public Member Functions
List Class Reference

#include <RobotAPI/libraries/aron/core/data/variant/container/List.h>

+ Inheritance diagram for List:

Public Member Functions

void addElement (const VariantPtr &)
 
size_t childrenSize () const override
 get the children size of a data variant
 
void clear ()
 
ListPtr clone (const Path &p) const override
 
bool fullfillsType (const type::VariantPtr &) const override
 checks, if the current data variant fullfills the given type
 
DictPtr getAsDict () const
 
std::vector< VariantPtr > getChildren () const override
 get the children of a data variant
 
VariantPtr getElement (unsigned int) const
 
std::vector< VariantPtr > getElements () const
 
std::string getFullName () const override
 get the full str representation of this variant
 
std::string getShortName () const override
 get a short str representation of this variant
 
bool hasElement (unsigned int) const
 
 List (const data::dto::ListPtr &, const Path &path=Path())
 
 List (const Path &path=Path())
 
 List (const std::vector< VariantPtr > &, const Path &path=Path())
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute
 
bool operator== (const List &) const override
 
bool operator== (const ListPtr &) const override
 
type::VariantPtr recalculateType () const override
 recalculate the type of a data variant. Please not tha the mapping ist NOT bijective, so the calculated type may be wrong
 
void removeElement (unsigned int)
 
void reserve (std::size_t size)
 Pre-allocate for size elements.
 
void setElement (unsigned int, const VariantPtr &)
 
data::dto::ListPtr toAronListDTO () const
 
- Public Member Functions inherited from ContainerVariant< data::dto::List, List >
 SpecializedVariantBase ()=delete
 
 SpecializedVariantBase ()=delete
 
 SpecializedVariantBase (const data::Descriptor descriptor, const Path &path=Path())
 
 SpecializedVariantBase (const data::Descriptor descriptor, const Path &path=Path())
 
 SpecializedVariantBase (const typename AronDataType::PointerType &o, const data::Descriptor descriptor, const Path &path=Path())
 
 SpecializedVariantBase (const typename AronDataType::PointerType &o, const data::Descriptor descriptor, const Path &path=Path())
 
virtual ~ContainerVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< data::dto::List, List >
virtual PointerType clone () const
 
VariantPtr cloneAsVariant () const override
 get a pointer to a copy of this variant
 
VariantPtr cloneAsVariant (const Path &newPath) const override
 
std::optional< float > getImportance () const override
 get optional importance metadata for this data variant.
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative
 
 operator typename AronDataType::PointerType ()
 
bool operator== (const Variant &other) const override
 
void setImportance (const std::optional< float > &importance) override
 set optional importance metadata in [0, 1] for this data variant.
 
 SpecializedVariantBase ()=delete
 
 SpecializedVariantBase (const data::Descriptor descriptor, const Path &path=Path())
 
 SpecializedVariantBase (const typename AronDataType::PointerType &o, const data::Descriptor descriptor, const Path &path=Path())
 
data::dto::GenericDataPtr toAronDTO () const override
 convert the variant to the ice representation
 
virtual ~SpecializedVariantBase ()=default
 
- Public Member Functions inherited from Variant
data::Descriptor getDescriptor () const
 getter for the descriptor enum
 
const Path & getPath () const
 get the path
 
bool operator== (const VariantPtr &other) const
 
std::string pathToString () const
 get the path as string
 
 Variant ()=delete
 
 Variant (const data::Descriptor &descriptor, const Path &path)
 
virtual ~Variant ()=default
 

Static Public Member Functions

static PointerType FromAronListDTO (const data::dto::ListPtr &aron)
 
static data::dto::ListPtr ToAronListDTO (const PointerType &navigator)
 
- Static Public Member Functions inherited from SpecializedVariantBase< data::dto::List, List >
static const List & DynamicCast (const Variant &n)
 
static PointerType DynamicCast (const VariantPtr &n)
 
static List & DynamicCast (Variant &n)
 
static PointerType DynamicCastAndCheck (const VariantPtr &n)
 
- Static Public Member Functions inherited from Variant
static VariantPtr FromAronDTO (const data::dto::GenericDataPtr &, const Path &=Path())
 create a variant from a dto object
 
static std::vector< VariantPtr > FromAronDTO (const std::vector< data::dto::GenericDataPtr > &, const Path &=Path())
 create a list of variants from a list of dto objects
 
static std::vector< data::dto::GenericDataPtr > ToAronDTO (const std::vector< VariantPtr > &)
 return a list of dto objects from a list of variant objects
 

Additional Inherited Members

- Public Types inherited from ContainerVariant< data::dto::List, List >
using Base
 
- Public Types inherited from SpecializedVariantBase< data::dto::List, List >
using AronDataType
 
using Base
 
using PointerType
 
- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Protected Attributes inherited from SpecializedVariantBase< data::dto::List, List >
AronDataType::PointerType aron
 
- Protected Attributes inherited from Variant
const data::Descriptor descriptor
 
const Path path
 

Constructor & Destructor Documentation

◆ List() [1/3]

List ( const Path & path = Path())

◆ List() [2/3]

List ( const data::dto::ListPtr & l,
const Path & path = Path() )

◆ List() [3/3]

List ( const std::vector< VariantPtr > & n,
const Path & path = Path() )

Member Function Documentation

◆ addElement()

void addElement ( const VariantPtr & n)

◆ childrenSize()

size_t childrenSize ( ) const
overridevirtual

get the children size of a data variant

Implements Variant.

◆ clear()

void clear ( )

◆ clone()

ListPtr clone ( const Path & p) const
overridevirtual

Implements SpecializedVariantBase< data::dto::List, List >.

◆ FromAronListDTO()

ListPtr FromAronListDTO ( const data::dto::ListPtr & aron)
static

◆ fullfillsType()

bool fullfillsType ( const type::VariantPtr & ) const
overridevirtual

checks, if the current data variant fullfills the given type

Implements Variant.

◆ getAsDict()

DictPtr getAsDict ( ) const

◆ getChildren()

std::vector< VariantPtr > getChildren ( ) const
overridevirtual

get the children of a data variant

Implements Variant.

◆ getElement()

VariantPtr getElement ( unsigned int i) const

◆ getElements()

std::vector< VariantPtr > getElements ( ) const

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full str representation of this variant

Implements Variant.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short str representation of this variant

Implements Variant.

◆ hasElement()

bool hasElement ( unsigned int i) const

◆ navigateAbsolute()

VariantPtr navigateAbsolute ( const Path & path) const
overridevirtual

naviate absolute

Implements Variant.

◆ operator==() [1/2]

bool operator== ( const List & other) const
overridevirtual

Implements SpecializedVariantBase< data::dto::List, List >.

◆ operator==() [2/2]

bool operator== ( const ListPtr & other) const
overridevirtual

Implements SpecializedVariantBase< data::dto::List, List >.

◆ recalculateType()

type::VariantPtr recalculateType ( ) const
overridevirtual

recalculate the type of a data variant. Please not tha the mapping ist NOT bijective, so the calculated type may be wrong

Implements Variant.

◆ removeElement()

void removeElement ( unsigned int i)

◆ reserve()

void reserve ( std::size_t size)

Pre-allocate for size elements.

Used by the writers, which know the element count up front, to avoid the repeated growth of both backing vectors.

◆ setElement()

void setElement ( unsigned int i,
const VariantPtr & n )

◆ ToAronListDTO()

data::dto::ListPtr ToAronListDTO ( const PointerType & navigator)
static

◆ toAronListDTO()

data::dto::ListPtr toAronListDTO ( ) const
The documentation for this class was generated from the following files: