dds::core::KeyedStringTopicType Class Reference

Class that is a built-in topic type that can be used to readily create Topics, DataReaders and DataWriters for this type without the need for code generation. More...

#include "BuiltinTopicTypes.hpp"

Inheritance diagram for dds::core::KeyedStringTopicType:

Public Member Functions
	KeyedStringTopicType ()
	KeyedStringTopicType (const std::string &key, const std::string &value)
const std::string &	key () const
void	key (const std::string &key)
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const
const std::string &	value () const
void	value (const std::string &value)

Detailed Description

Class that is a built-in topic type that can be used to readily create Topics, DataReaders and DataWriters for this type without the need for code generation.

This built-in type allows for easy transfer of keyed strings.

Definition at line 127 of file BuiltinTopicTypes.hpp.

Constructor & Destructor Documentation

KeyedStringTopicType() [1/2]

dds::core::KeyedStringTopicType::KeyedStringTopicType

(

)

Creates topic type with an empty key and data strings.

KeyedStringTopicType() [2/2]

dds::core::KeyedStringTopicType::KeyedStringTopicType	(	const std::string &	key,
		const std::string &	value
	)

Creates topic type with the given key and data strings.

Member Function Documentation

key() [1/2]

const std::string& dds::core::KeyedStringTopicType::key

(

)

const

Getter function for the key string.

key() [2/2]

void dds::core::KeyedStringTopicType::key

(

const std::string &

key

)

Setter function for the key string.

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

Definition at line 99 of file Value.hpp.

operator->() [1/2]

template<typename D >

D * dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 111 of file Value.hpp.

operator->() [2/2]

template<typename D >

const D * dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 105 of file Value.hpp.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

Definition at line 93 of file Value.hpp.

value() [1/2]

const std::string& dds::core::KeyedStringTopicType::value

(

)

const

Getter function for the internal data string.

value() [2/2]

void dds::core::KeyedStringTopicType::value

(

const std::string &

value

)

Setter function for the internal data string.

---

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

• include/dcps/C++/isocpp2/dds/core/BuiltinTopicTypes.hpp