Robot Raconteur Core C++ Library
Loading...
Searching...
No Matches
RobotRaconteur::NamedTypeDefinition Class Referenceabstract

Base class for user-defined named types. More...

#include <ServiceDefinition.h>

Inheritance diagram for RobotRaconteur::NamedTypeDefinition:
RobotRaconteur::EnumDefinition RobotRaconteur::ServiceEntryDefinition

Public Member Functions

virtual DataTypes RRDataType () const =0
 The type code of the type.
virtual std::string ResolveQualifiedName ()=0
 Resolves and returns the qualified name.

Public Attributes

std::string Name
 The unqualified name of the type.

Detailed Description

Base class for user-defined named types.

User-defined types are called "named types", since they are named in the declaration, and that name is stored within messages when serialized in the ElementTypeName field.

Member Function Documentation

◆ ResolveQualifiedName()

virtual std::string RobotRaconteur::NamedTypeDefinition::ResolveQualifiedName ( )
pure virtual

Resolves and returns the qualified name.

The Name field contains the unqualified name, meaning that it does not contain the service definition name. A qualified name contains the service definition name, a dot, and the unqualified name. An example is the qualified name "example.named_example.struct1", where "example.named_example" is the service definition name, and "struct1" is the unqualified name of the struct.

ResolveQualifiedName() will attempt to determine the fully qualified name of the type, or throw an exception if it is unable.

Implemented in RobotRaconteur::EnumDefinition, and RobotRaconteur::ServiceEntryDefinition.


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