DataRepresentationQosPolicy Class Reference

With multiple standard data Representations available, and vendor-specific extensions possible, DataWriters and DataReaders must be able to negotiate which data representation(s) to use. More...

#include <QosPolicies.hpp>

Inheritance diagram for DataRepresentationQosPolicy:

Public Member Functions
FASTDDS_EXPORTED_API	DataRepresentationQosPolicy ()
	Constructor.
virtual FASTDDS_EXPORTED_API	~DataRepresentationQosPolicy () override=default
	Destructor.
bool	operator== (const DataRepresentationQosPolicy &b) const
	Compares the given policy to check if it's equal.
void	clear () override
	Clears the QosPolicy object.
Public Member Functions inherited from Parameter_t
FASTDDS_EXPORTED_API	Parameter_t ()
	Constructor without parameters.
FASTDDS_EXPORTED_API	Parameter_t (ParameterId_t pid, uint16_t length)
	Constructor using a parameter PID and the parameter length.
virtual FASTDDS_EXPORTED_API	~Parameter_t ()
	Destructor.
bool	operator== (const Parameter_t &b) const
Public Member Functions inherited from QosPolicy
	QosPolicy ()
	Constructor without parameters.
	QosPolicy (bool send_always)
	Constructor.
	QosPolicy (const QosPolicy &b)=default
	Copy Constructor.
virtual	~QosPolicy ()=default
	Destructor.
bool	operator== (const QosPolicy &b) const
QosPolicy &	operator= (const QosPolicy &b)=default
virtual bool	send_always () const
	Whether it should always be sent.

Public Attributes
std::vector< DataRepresentationId_t >	m_value
	List of DataRepresentationId. By default, empty list.
Public Attributes inherited from Parameter_t
ParameterId_t	Pid
	Parameter ID. By default, PID_PAD.
uint16_t	length
	Parameter length. By default, 0.
Public Attributes inherited from QosPolicy
bool	hasChanged
	Boolean that indicates if the Qos has been changed with respect to the default Qos.

Additional Inherited Members
Protected Attributes inherited from QosPolicy
bool	send_always_
	Boolean that indicates if the Qos has to be sent even if it is not changed.

Detailed Description

With multiple standard data Representations available, and vendor-specific extensions possible, DataWriters and DataReaders must be able to negotiate which data representation(s) to use.

This negotiation shall occur based on DataRepresentationQosPolicy.

Warning

If a writer’s offered representation is contained within a reader’s sequence, the offer satisfies the request and the policies are compatible. Otherwise, they are incompatible.

Note

Immutable Qos Policy

Constructor & Destructor Documentation

DataRepresentationQosPolicy()

FASTDDS_EXPORTED_API DataRepresentationQosPolicy ( )

inline

Constructor.

~DataRepresentationQosPolicy()

virtual FASTDDS_EXPORTED_API ~DataRepresentationQosPolicy ( )

overridevirtualdefault

Destructor.

Member Function Documentation

clear()

void clear ( )

inlineoverridevirtual

Clears the QosPolicy object.

Implements QosPolicy.

operator==()

bool operator== ( const DataRepresentationQosPolicy & b ) const

inline

Compares the given policy to check if it's equal.

Parameters

b	QoS Policy.

Returns

True if the policy is equal.

Member Data Documentation

m_value

std::vector<DataRepresentationId_t> m_value

List of DataRepresentationId.
By default, empty list.

---

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

• include/fastdds/dds/core/policy/QosPolicies.hpp