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

The Dict class. More...

#include <RobotAPI/libraries/aron/core/type/variant/container/Dict.h>

+ Inheritance diagram for Dict:

Public Member Functions

size_t childrenSize () const override
 
 Dict (const Path &path=Path())
 
 Dict (const type::dto::Dict &, const Path &path=Path())
 
VariantPtr getAcceptedType () const
 
std::vector< VariantPtr > getChildren () const override
 get all child elements
 
std::string getFullName () const override
 get the full name of this specific type
 
std::string getShortName () const override
 get a short name of this specific type
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute
 
void setAcceptedType (const VariantPtr &)
 
type::dto::DictPtr toDictDTO () const
 
- Public Member Functions inherited from ContainerVariant< type::dto::Dict, Dict >
virtual ~ContainerVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< type::dto::Dict, Dict >
std::optional< float > getImportance () const override
 get optional importance metadata for this type variant.
 
type::Maybe getMaybe () const override
 get the maybe type
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative
 
 operator type::dto::Dict ()
 
bool operator== (const Dict &other) const
 
bool operator== (const Variant &other) const override
 
void setImportance (const std::optional< float > &importance) override
 set optional importance metadata in [0, 1] for this type variant.
 
void setMaybe (const type::Maybe m) override
 set the maybetype of this type
 
 SpecializedVariantBase (const type::Descriptor &descriptor, const Path &path)
 
 SpecializedVariantBase (const type::dto::Dict &o, const type::Descriptor &descriptor, const Path &path)
 
type::dto::GenericTypePtr toAronDTO () const override
 convert this variant to a dto object.
 
virtual ~SpecializedVariantBase ()=default
 
- Public Member Functions inherited from Variant
type::Descriptor getDescriptor () const
 
Path getPath () const
 
bool operator== (const VariantPtr &other) const
 
std::string pathToString () const
 
 Variant (const type::Descriptor &descriptor, const Path &path=Path())
 
virtual ~Variant ()=default
 

Static Public Member Functions

static std::string GetFullNamePrefix ()
 
static std::string GetNamePrefix ()
 
- Static Public Member Functions inherited from SpecializedVariantBase< type::dto::Dict, Dict >
static const Dict & DynamicCast (const Variant &n)
 
static std::shared_ptr< Dict > DynamicCast (const VariantPtr &n)
 
static Dict & DynamicCast (Variant &n)
 
static std::shared_ptr< Dict > DynamicCastAndCheck (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
 

Additional Inherited Members

- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Protected Attributes inherited from SpecializedVariantBase< type::dto::Dict, Dict >
type::dto::Dict::PointerType aron
 
- Protected Attributes inherited from Variant
const type::Descriptor descriptor
 
const Path path
 

Detailed Description

The Dict class.

It represents the dict type A dict only has an accepted type (a variant) for the corresponding data object

See also
data/variant/container/Dict.h

Definition at line 39 of file Dict.h.

Constructor & Destructor Documentation

◆ Dict() [1/2]

Dict ( const Path & path = Path())

Definition at line 30 of file Dict.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Dict() [2/2]

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

Definition at line 35 of file Dict.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ childrenSize()

size_t childrenSize ( ) const
overridevirtual

Implements Variant.

Definition at line 70 of file Dict.cpp.

◆ getAcceptedType()

VariantPtr getAcceptedType ( ) const

Definition at line 42 of file Dict.cpp.

+ Here is the caller graph for this function:

◆ getChildren()

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

get all child elements

Implements Variant.

Definition at line 64 of file Dict.cpp.

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 82 of file Dict.cpp.

◆ GetFullNamePrefix()

std::string GetFullNamePrefix ( )
static

Definition at line 88 of file Dict.cpp.

◆ GetNamePrefix()

std::string GetNamePrefix ( )
static

Definition at line 94 of file Dict.cpp.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 76 of file Dict.cpp.

◆ navigateAbsolute()

VariantPtr navigateAbsolute ( const Path & path) const
overridevirtual

naviate absolute

Implements Variant.

Definition at line 100 of file Dict.cpp.

◆ setAcceptedType()

void setAcceptedType ( const VariantPtr & a)

Definition at line 49 of file Dict.cpp.

◆ toDictDTO()

type::dto::DictPtr toDictDTO ( ) const

Definition at line 57 of file Dict.cpp.

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