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

#include <RobotAPI/libraries/aron/core/data/variant/primitive/String.h>

+ Inheritance diagram for String:

Public Member Functions

void fromString (const std::string &setter) override
 set a primitive from a std string
 
bool fullfillsType (const type::VariantPtr &) const override
 checks, if the current data variant fullfills the given type
 
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 operator== (const String &) const override
 
bool operator== (const StringPtr &) 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
 
 String (const data::dto::AronStringPtr &, const Path &=Path())
 
 String (const Path &=Path())
 
 String (const std::string &, const Path &=Path())
 
data::dto::AronStringPtr toAronStringDTO () const
 
- Public Member Functions inherited from PrimitiveVariant< data::dto::AronString, std::string, String >
size_t childrenSize () const override
 get the children size of a data variant
 
virtual PointerType clone () const
 
virtual PointerType clone () const
 
PointerType clone (const Path &newPath) const override
 
DictPtr getAsDict () const
 
std::vector< VariantPtr > getChildren () const override
 get the children of a data variant
 
std::string & getValue ()
 
std::string getValue () const
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute
 
 operator std::string () const
 
String & operator= (const std::string &x)
 
 PrimitiveVariant (const std::string &v, const data::Descriptor descriptor, const Path &path=Path())
 
void setValue (const std::string &x)
 
 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 ~PrimitiveVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< data::dto::AronString, String >
VariantPtr cloneAsVariant () const override
 get a pointer to a copy of this variant
 
VariantPtr cloneAsVariant (const Path &newPath) const override
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative
 
 operator typename AronDataType::PointerType ()
 
bool operator== (const Variant &other) const override
 
 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
 
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 StringPtr FromAronStringDTO (const data::dto::AronStringPtr &aron)
 
static data::dto::AronStringPtr ToAronStringDTO (const StringPtr &navigator)
 
- Static Public Member Functions inherited from SpecializedVariantBase< data::dto::AronString, String >
static const String & DynamicCast (const Variant &n)
 
static PointerType DynamicCast (const VariantPtr &n)
 
static String & 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 PrimitiveVariant< data::dto::AronString, std::string, String >
using Base
 
using PointerType
 
using ValueType
 
- Public Types inherited from SpecializedVariantBase< data::dto::AronString, String >
using AronDataType
 
using Base
 
using PointerType
 
- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Protected Attributes inherited from SpecializedVariantBase< data::dto::AronString, String >
AronDataType::PointerType aron
 
- Protected Attributes inherited from Variant
const data::Descriptor descriptor
 
const Path path
 

Detailed Description

Definition at line 41 of file String.h.

Constructor & Destructor Documentation

◆ String() [1/3]

String ( const Path & path = Path())

Definition at line 39 of file String.cpp.

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

◆ String() [2/3]

String ( const data::dto::AronStringPtr & o,
const Path & path = Path() )

Definition at line 31 of file String.cpp.

+ Here is the call graph for this function:

◆ String() [3/3]

String ( const std::string & d,
const Path & path = Path() )

Definition at line 46 of file String.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ FromAronStringDTO()

StringPtr FromAronStringDTO ( const data::dto::AronStringPtr & aron)
static

Definition at line 78 of file String.cpp.

◆ fromString()

void fromString ( const std::string & setter)
overridevirtual

set a primitive from a std string

Implements PrimitiveVariant< data::dto::AronString, std::string, String >.

Definition at line 102 of file String.cpp.

+ Here is the call graph for this function:

◆ fullfillsType()

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

checks, if the current data variant fullfills the given type

Implements Variant.

Definition at line 120 of file String.cpp.

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full str representation of this variant

Implements Variant.

Definition at line 114 of file String.cpp.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short str representation of this variant

Implements Variant.

Definition at line 108 of file String.cpp.

◆ operator==() [1/2]

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

Implements SpecializedVariantBase< data::dto::AronString, String >.

Definition at line 56 of file String.cpp.

+ Here is the call graph for this function:

◆ operator==() [2/2]

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

Implements SpecializedVariantBase< data::dto::AronString, String >.

Definition at line 67 of file String.cpp.

◆ 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.

Definition at line 128 of file String.cpp.

◆ ToAronStringDTO()

data::dto::AronStringPtr ToAronStringDTO ( const StringPtr & navigator)
static

Definition at line 88 of file String.cpp.

◆ toAronStringDTO()

data::dto::AronStringPtr toAronStringDTO ( ) const

Definition at line 95 of file String.cpp.

+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: