String Class Reference

The String class. More...

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

+ Inheritance diagram for String:

Public Types

using Base = detail::PrimitiveVariant< type::dto::AronString, String, std::string >
 
- Public Types inherited from PrimitiveVariant< type::dto::AronString, String, std::string >
using Base = SpecializedVariantBase< type::dto::AronString, String >
 
using ValueType = std::string
 
- Public Types inherited from Variant
using PointerType = VariantPtr
 

Public Member Functions

virtual std::string getFullName () const override
 get the full name of this specific type More...
 
virtual std::string getShortName () const override
 get a short name of this specific type More...
 
 String (const Path &=Path())
 
 String (const type::dto::AronString &, const Path &=Path())
 
type::dto::AronStringPtr toStringDTO () const
 
- Public Member Functions inherited from PrimitiveVariant< type::dto::AronString, String, std::string >
size_t childrenSize () const override
 
std::vector< VariantPtrgetChildren () const override
 get all child elements More...
 
std::optional< ValueTypegetDefaultValue () const
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute More...
 
void setDefaultValue (const std::optional< ValueType > &v)
 
 SpecializedVariantBase (const type::Descriptor &descriptor, const Path &path)
 
 SpecializedVariantBase (const type::dto::AronString &o, const type::Descriptor &descriptor, const Path &path)
 
virtual ~PrimitiveVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< type::dto::AronString, String >
type::Maybe getMaybe () const override
 get the maybe type More...
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative More...
 
 operator type::dto::AronString ()
 
bool operator== (const String &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::AronString &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
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecializedVariantBase< type::dto::AronString, String >
static const StringDynamicCast (const Variant &n)
 
static std::shared_ptr< StringDynamicCast (const VariantPtr &n)
 
static StringDynamicCast (Variant &n)
 
static std::shared_ptr< StringDynamicCastAndCheck (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::AronString, String >
type::dto::AronString ::PointerType aron
 
- Protected Attributes inherited from Variant
const type::Descriptor descriptor
 
const Path path
 

Detailed Description

The String class.

It represents the string type

Definition at line 37 of file String.h.

Member Typedef Documentation

◆ Base

using Base = detail::PrimitiveVariant<type::dto::AronString, String, std::string>

Definition at line 40 of file String.h.

Constructor & Destructor Documentation

◆ String() [1/2]

String ( const Path path = Path())

Definition at line 35 of file String.cpp.

◆ String() [2/2]

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

Definition at line 39 of file String.cpp.

Member Function Documentation

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 59 of file String.cpp.

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 53 of file String.cpp.

◆ toStringDTO()

type::dto::AronStringPtr toStringDTO ( ) const

Definition at line 46 of file String.cpp.


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