Robot Raconteur Core C++ Library
Loading...
Searching...
No Matches
RobotRaconteur::UsingDefinition Class Reference

Class for using definitions. More...

#include <ServiceDefinition.h>

Public Member Functions

 UsingDefinition (const boost::shared_ptr< ServiceDefinition > &service)
 Construct a new empty UsingDefinition object.
std::string ToString ()
 Convert using definition to string.
void FromString (boost::string_ref s, const ServiceDefinitionParseInfo *parse_info=NULL)
 Parse an using definition from string.

Public Attributes

std::string QualifiedName
 The qualified name of the imported type.
std::string UnqualifiedName
 The unqualified name of the imported type.
RR_WEAK_PTR< ServiceDefinitionservice
 The parent service definition.
ServiceDefinitionParseInfo ParseInfo
 Parsing diagnostic information.

Detailed Description

Class for using definitions.

See service_definitions.md for more information.

Constructor & Destructor Documentation

◆ UsingDefinition()

RobotRaconteur::UsingDefinition::UsingDefinition ( const boost::shared_ptr< ServiceDefinition > & service)

Construct a new empty UsingDefinition object.

Must be constructed with boost::make_shared<UsingDefinition>()

Parameters
serviceThe parent service definition

Member Function Documentation

◆ FromString()

void RobotRaconteur::UsingDefinition::FromString ( boost::string_ref s,
const ServiceDefinitionParseInfo * parse_info = NULL )

Parse an using definition from string.

Parameters
sThe using definition string
parse_infoParsing diagnostic information

◆ ToString()

std::string RobotRaconteur::UsingDefinition::ToString ( )

Convert using definition to string.

Returns
std::string The using definition string

Member Data Documentation

◆ ParseInfo

ServiceDefinitionParseInfo RobotRaconteur::UsingDefinition::ParseInfo

Parsing diagnostic information.

The ParseInfo field is populated by FromString()


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