org::opensplice::core::policy::ProductData Class Reference

QoS Policy to for ProductData. More...

#include "ProprietaryApi.hpp"

Inheritance diagram for org::opensplice::core::policy::ProductData:

Public Member Functions
	ProductData ()
	ProductData (const std::string &name)
	ProductData (const ProductData &other)
ProductData &	name (const std::string &name)
std::string	name () const
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const

Detailed Description

QoS Policy to for ProductData.

This Policy is part of many proprietary builtin topics:

• org::opensplice::topic::CMParticipantBuiltinTopicData
• org::opensplice::topic::CMPublisherBuiltinTopicData
• org::opensplice::topic::CMSubscriberBuiltinTopicData
• org::opensplice::topic::CMDataWriterBuiltinTopicData
• org::opensplice::topic::CMDataReaderBuiltinTopicData

The policy contains product information of the product that created the related entity. The data will be formatted in XML. It is mostly used by OpenSplice tools to display extended information about the discovered entities.

Definition at line 793 of file ProprietaryApi.hpp.

Constructor & Destructor Documentation

ProductData() [1/3]

org::opensplice::core::policy::ProductData::ProductData

(

)

Creates a ProductData QoS Policy instance

ProductData() [2/3]

org::opensplice::core::policy::ProductData::ProductData

(

const std::string &

name

)

Creates a ProductData QoS Policy instance

Parameters

value

the value

ProductData() [3/3]

org::opensplice::core::policy::ProductData::ProductData

(

const ProductData &

other

)

Copies a ProductData QoS Policy instance

Parameters

other

the ProductData QoS Policy instance to copy

Member Function Documentation

name() [1/2]

ProductData& org::opensplice::core::policy::ProductData::name

(

const std::string &

name

)

Sets the name

Parameters

value

the name

name() [2/2]

std::string org::opensplice::core::policy::ProductData::name

(

)

const

Gets the name

Returns

the name

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.

---

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

• include/dcps/C++/isocpp2/dds/core/detail/ProprietaryApi.hpp