ola::rdm::StringMessageBuilder Class Reference

Detailed Description

This visitor builds a message based on a vector of strings from a Descriptor.

Inheritance diagram for ola::rdm::StringMessageBuilder:

Public Member Functions
	~StringMessageBuilder ()
	Clean up.
bool	Descend () const
const ola::messaging::Message *	GetMessage (const std::vector< std::string > &inputs, const class ola::messaging::Descriptor *descriptor)
	Get the Message object that this Builder created.
const std::string	GetError () const
void	Visit (const ola::messaging::BoolFieldDescriptor *)
void	Visit (const ola::messaging::IPV4FieldDescriptor *)
void	Visit (const ola::messaging::MACFieldDescriptor *)
void	Visit (const ola::messaging::UIDFieldDescriptor *)
void	Visit (const ola::messaging::StringFieldDescriptor *)
void	Visit (const ola::messaging::UInt8FieldDescriptor *)
void	Visit (const ola::messaging::UInt16FieldDescriptor *)
void	Visit (const ola::messaging::UInt32FieldDescriptor *)
void	Visit (const ola::messaging::Int8FieldDescriptor *)
void	Visit (const ola::messaging::Int16FieldDescriptor *)
void	Visit (const ola::messaging::Int32FieldDescriptor *)
void	Visit (const ola::messaging::FieldDescriptorGroup *)
void	PostVisit (const ola::messaging::FieldDescriptorGroup *)
Public Member Functions inherited from ola::messaging::FieldDescriptorVisitor
virtual void	Visit (const IntegerFieldDescriptor< uint8_t > *)=0
virtual void	Visit (const IntegerFieldDescriptor< uint16_t > *)=0
virtual void	Visit (const IntegerFieldDescriptor< uint32_t > *)=0
virtual void	Visit (const IntegerFieldDescriptor< int8_t > *)=0
virtual void	Visit (const IntegerFieldDescriptor< int16_t > *)=0
virtual void	Visit (const IntegerFieldDescriptor< int32_t > *)=0

Member Function Documentation

const ola::messaging::Message * ola::rdm::StringMessageBuilder::GetMessage	(	const std::vector< std::string > &	inputs,
		const class ola::messaging::Descriptor *	descriptor
	)

Get the Message object that this Builder created.

This method is not re-entrant.

Parameters

inputs	the string inputs provided to build the Message
descriptor	the descriptor to use to build the Message

Returns

a Message object, or NULL if the inputs failed.

void ola::rdm::StringMessageBuilder::PostVisit ( const ola::messaging::FieldDescriptorGroup *  descriptor )

virtual

This is a noop since we handle decending ourselfs in Visit()

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::BoolFieldDescriptor *  descriptor )

virtual

Bool values can be true,false,0,1

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::IPV4FieldDescriptor *  descriptor )

virtual

IPV4 Addresses

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::MACFieldDescriptor *  descriptor )

virtual

MAC Addresses

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::UIDFieldDescriptor *  descriptor )

virtual

UIDs.

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::StringFieldDescriptor *  descriptor )

virtual

Handle strings

Implements ola::messaging::FieldDescriptorVisitor.

void ola::rdm::StringMessageBuilder::Visit

(

const ola::messaging::UInt8FieldDescriptor *

descriptor

)

uint8

void ola::rdm::StringMessageBuilder::Visit ( const ola::messaging::FieldDescriptorGroup *  descriptor )

virtual

Visit a group

Implements ola::messaging::FieldDescriptorVisitor.

---

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

• include/ola/rdm/StringMessageBuilder.h
• common/rdm/StringMessageBuilder.cpp