Base class for member definitions. More...

#include <ServiceDefinition.h>

Inheritance diagram for RobotRaconteur::MemberDefinition:

Public Member Functions
virtual MemberDefinition_NoLock	NoLock () const
	Get member locking behavior.
virtual std::string	ToString ()
	Convert member to a string.
virtual void	Reset ()
	Clear all fields.

Public Attributes
std::string	Name
	The name of the member.
RR_WEAK_PTR< ServiceEntryDefinition >	ServiceEntry
	The parent service entry definition.
std::vector< std::string >	Modifiers
	Modifiers for this member.
ServiceDefinitionParseInfo	ParseInfo
	Parsing diagnostic information.
std::string	DocString
	Documentation string for the member.

Detailed Description

Base class for member definitions.

Members are contained within service entry definitions. Subclasses of MemberDefinition represent each specific member type.

Member Function Documentation

◆ NoLock()

virtual MemberDefinition_NoLock RobotRaconteur::MemberDefinition::NoLock ( ) const

virtual

Get member locking behavior.

Members may use modifiers to change behavior when an object is locked using RobotRaconteurNode::RequestObjectLock() or ServerContext::RequestObjectLock() By default, access to the object is protected against other users/sessions. Members can be declared nolock or nolockread to allow objects to be unlocked, or unlocked for read operations. See object_locks.md for more information.

Returns: MemberDefinition_NoLock The locking behavior

◆ ToString()

virtual std::string RobotRaconteur::MemberDefinition::ToString ( )

inlinevirtual

Convert member to a string.

Returned member string is in Service Definition IDL format

Returns: std::string The member as a string

Reimplemented in RobotRaconteur::CallbackDefinition, RobotRaconteur::EventDefinition, RobotRaconteur::FunctionDefinition, RobotRaconteur::MemoryDefinition, RobotRaconteur::ObjRefDefinition, RobotRaconteur::PipeDefinition, RobotRaconteur::PropertyDefinition, and RobotRaconteur::WireDefinition.

Member Data Documentation

◆ Modifiers

std::vector<std::string> RobotRaconteur::MemberDefinition::Modifiers

Modifiers for this member.

Modifiers are used to modify the behavior of the member. See service_definitions.md for more information on valid modifiers.

◆ ParseInfo

ServiceDefinitionParseInfo RobotRaconteur::MemberDefinition::ParseInfo

Parsing diagnostic information.

The ParseInfo field is populated by the FromString() function of the member

◆ ServiceEntry

RR_WEAK_PTR<ServiceEntryDefinition> RobotRaconteur::MemberDefinition::ServiceEntry

The parent service entry definition.

Stored as a weak_ptr to prevent circular reference counts

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

/builddir/build/BUILD/robotraconteur-1.2.8-build/RobotRaconteur-1.2.8-Source/RobotRaconteurCore/include/RobotRaconteur/ServiceDefinition.h

Public Member Functions

Public Attributes