Tuple Class Reference

The Tuple class. More...

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

+ Inheritance diagram for Tuple:

Public Member Functions

void addAcceptedType (const VariantPtr &)
 
size_t childrenSize () const override
 
VariantPtr getAcceptedType (unsigned int i) const
 
std::vector< VariantPtrgetAcceptedTypes () const
 
std::vector< VariantPtrgetChildren () const override
 get all child elements More...
 
std::string getFullName () const override
 get the full name of this specific type More...
 
std::string getShortName () const override
 get a short name of this specific type More...
 
bool hasAcceptedType (unsigned int i) const
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute More...
 
void setAcceptedTypes (const std::vector< VariantPtr > &)
 
type::dto::TuplePtr toTupleDTO () const
 
 Tuple (const Path &path=Path())
 
 Tuple (const type::dto::Tuple &, const Path &path=Path())
 
- Public Member Functions inherited from ContainerVariant< type::dto::Tuple, Tuple >
virtual ~ContainerVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< type::dto::Tuple, Tuple >
type::Maybe getMaybe () const override
 get the maybe type More...
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative More...
 
 operator type::dto::Tuple ()
 
bool operator== (const Tuple &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::Tuple &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
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 Member Functions

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

Additional Inherited Members

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

Detailed Description

The Tuple class.

It represents the tuple type A tuple has a list of accepted types

Definition at line 39 of file Tuple.h.

Constructor & Destructor Documentation

◆ Tuple() [1/2]

Tuple ( const Path path = Path())

Definition at line 32 of file Tuple.cpp.

◆ Tuple() [2/2]

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

Definition at line 37 of file Tuple.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ addAcceptedType()

void addAcceptedType ( const VariantPtr v)

Definition at line 87 of file Tuple.cpp.

+ Here is the call graph for this function:

◆ childrenSize()

size_t childrenSize ( ) const
overridevirtual

Implements Variant.

Definition at line 102 of file Tuple.cpp.

◆ getAcceptedType()

VariantPtr getAcceptedType ( unsigned int  i) const

Definition at line 71 of file Tuple.cpp.

◆ getAcceptedTypes()

std::vector< VariantPtr > getAcceptedTypes ( ) const

Definition at line 59 of file Tuple.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 96 of file Tuple.cpp.

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 119 of file Tuple.cpp.

+ Here is the call graph for this function:

◆ GetFullNamePrefix()

std::string GetFullNamePrefix ( )
static

Definition at line 130 of file Tuple.cpp.

◆ GetNamePrefix()

std::string GetNamePrefix ( )
static

Definition at line 136 of file Tuple.cpp.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 108 of file Tuple.cpp.

+ Here is the call graph for this function:

◆ hasAcceptedType()

bool hasAcceptedType ( unsigned int  i) const

Definition at line 65 of file Tuple.cpp.

◆ navigateAbsolute()

VariantPtr navigateAbsolute ( const Path path) const
overridevirtual

naviate absolute

Implements Variant.

Definition at line 142 of file Tuple.cpp.

+ Here is the call graph for this function:

◆ setAcceptedTypes()

void setAcceptedTypes ( const std::vector< VariantPtr > &  acceptedTypes)

Definition at line 77 of file Tuple.cpp.

◆ toTupleDTO()

type::dto::TuplePtr toTupleDTO ( ) const

Definition at line 48 of file Tuple.cpp.

+ Here is the call graph for this function:

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