DataWriter that provides static memory to TypedDataWriter. More...

#include <StaticDataWriter.hpp>

Public Member Functions
	StaticDataWriter (BasePublisher &publisher, BaseTopic &topic, const DataWriterQos &qos, DataWriterListener *listener, const StatusMask &mask) noexcept
	StaticDataWriter constructor. More...

virtual	~StaticDataWriter () noexcept=default
	Virtual destructor. More...

	StaticDataWriter (const StaticDataWriter &) noexcept=delete
	Copy deleted. More...

	StaticDataWriter (StaticDataWriter &&) noexcept=delete
	Movement deleted. More...

StaticDataWriter &	operator= (const StaticDataWriter &) noexcept=delete
	Copy operator deleted. More...

StaticDataWriter &	operator= (StaticDataWriter &&) noexcept=delete
	Movement operator deleted due private references. More...

ReturnCode	enable () noexcept override

Public Member Functions inherited from eprosima::safedds::dds::TypedDataWriter< TS >
InstanceHandle	register_instance (const Data &data) noexcept
	Register instance. More...

InstanceHandle	register_instance_w_timestamp (const Data &data, const execution::TimePoint &timestamp) noexcept
	Register instance with timestamp. More...

ReturnCode	unregister_instance (const Data &data, const InstanceHandle &handle) noexcept
	Unregister instance. More...

ReturnCode	unregister_instance_w_timestamp (const Data &data, const InstanceHandle &handle, const execution::TimePoint &timestamp) noexcept
	Unregister instance with timestamp. More...

ReturnCode	get_key_value (Data &key_holder, const InstanceHandle &handle) noexcept
	Get key value of an instance. More...

InstanceHandle	lookup_instance (const Data &instance) const noexcept
	Lookup instance. More...

ReturnCode	write (const Data &data, const InstanceHandle &handle) noexcept
	Write data. More...

ReturnCode	write_w_timestamp (const Data &data, const InstanceHandle &handle, const execution::TimePoint &timestamp) noexcept
	Write data with timestamp. More...

ReturnCode	dispose (const Data &data, const InstanceHandle &handle) noexcept
	Dispose instance. More...

ReturnCode	dispose_w_timestamp (const Data &data, const InstanceHandle &handle, const execution::TimePoint &timestamp) noexcept
	Dispose instance with timestamp. More...

Additional Inherited Members
Public Types inherited from eprosima::safedds::dds::TypedDataWriter< TS >
using	Data = typename TS::DataType
	Alias for nested DataType. More...

Static Public Member Functions inherited from eprosima::safedds::dds::TypedDataWriter< TS >
static TypedDataWriter< TS > *	downcast (DataWriter &writer) noexcept
	Downcast TypedDataWriter from DataWriter. More...

Protected Member Functions inherited from eprosima::safedds::dds::TypedDataWriter< TS >
	TypedDataWriter (BasePublisher &publisher, BaseTopic &topic, const DataWriterQos &qos, DataWriterListener *listener, const StatusMask &mask, IDataWriterInstanceStorage &instance_storage, protocol::rtps::Writer &writer) noexcept
	TypedDataWriter constructor. More...

	~TypedDataWriter () noexcept=default
	Protected destructor ownership defined on creation. More...

	TypedDataWriter (const TypedDataWriter &) noexcept=delete
	Copy allowed. More...

	TypedDataWriter (TypedDataWriter &&) noexcept=delete
	Movement allowed. More...

TypedDataWriter &	operator= (const TypedDataWriter &) noexcept=delete
	Copy operator allowed. More...

TypedDataWriter &	operator= (TypedDataWriter &&) noexcept=delete
	Movement operator allowed. More...

ReturnCode	extended_write (const Data &data, const InstanceHandle &handle, const execution::TimePoint &timestamp, const UserInlineQoS *user_inline_qos, datacentric::SampleKey &key) noexcept
	Write data with extended information: timestamp and inline QoS, returns sample key. Not standard DDS API. More...

Detailed Description

template<class TS, uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>
class eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >

DataWriter that provides static memory to TypedDataWriter.

Template Parameters

TS	is the type support type.
MaxRemoteReaders	is the maximum amount of remote readers.
MaxInstances	is the maximum amount of instances.
MaxSamplesPerInstance	is the maximum amount of samples per instance.

Constructor & Destructor Documentation

◆ StaticDataWriter() [1/3]

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::StaticDataWriter	(	BasePublisher &	publisher,
		BaseTopic &	topic,
		const DataWriterQos &	qos,
		DataWriterListener *	listener,
		const StatusMask &	mask
	)

inlinenoexcept

StaticDataWriter constructor.

Parameters

publisher	reference to BasePublisher. Ownership is not taken.
topic	reference to topic. Ownership is not taken.
qos	data writer qos.
listener	data writer listener. Ownership is not taken.
mask	status mask.

◆ ~StaticDataWriter()

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

virtual eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::~StaticDataWriter ( )

virtualdefaultnoexcept

Virtual destructor.

◆ StaticDataWriter() [2/3]

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::StaticDataWriter ( const StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance > & )

deletenoexcept

Copy deleted.

◆ StaticDataWriter() [3/3]

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::StaticDataWriter ( StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance > && )

deletenoexcept

Movement deleted.

Member Function Documentation

◆ enable()

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

ReturnCode eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::enable ( )

inlineoverridenoexcept

◆ operator=() [1/2]

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

StaticDataWriter& eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::operator= ( const StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance > & )

deletenoexcept

Copy operator deleted.

◆ operator=() [2/2]

template<class TS , uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

StaticDataWriter& eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >::operator= ( StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance > && )

deletenoexcept

Movement operator deleted due private references.

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

build/docs/user_manual/main/tmp/include/safedds/dds/static/StaticDataWriter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<class TS, uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance> class eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >

Constructor & Destructor Documentation

◆ StaticDataWriter() [1/3]

◆ ~StaticDataWriter()

◆ StaticDataWriter() [2/3]

◆ StaticDataWriter() [3/3]

Member Function Documentation

◆ enable()

◆ operator=() [1/2]

◆ operator=() [2/2]

template<class TS, uint32_t MaxRemoteReaders, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>
class eprosima::safedds::dds::StaticDataWriter< TS, MaxRemoteReaders, MaxInstances, MaxSamplesPerInstance >