Class WriteParams

Nested Relationships

Nested Types

Class Documentation

class WriteParams

This class contains additional information of a CacheChange.

Public Functions

inline WriteParams &sample_identity(const SampleIdentity &sample_id)

Set the value of the sample_identity member.

Parameters:

sample_id – New value for the sample_identity member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline WriteParams &sample_identity(SampleIdentity &&sample_id)

Set the value of the sample_identity member.

Parameters:

sample_id – New value for the sample_identity member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline const SampleIdentity &sample_identity() const

Get the value of the sample_identity member.

Returns:

Constant reference to the sample_identity member.

inline SampleIdentity &sample_identity()

Set the value of the sample_identity member.

Returns:

Reference to the sample_identity member.

inline WriteParams &related_sample_identity(const SampleIdentity &sample_id)

Set the value of the related_sample_identity member of this class.

Parameters:

sample_id – New value for the related_sample_identity member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline WriteParams &related_sample_identity(SampleIdentity &&sample_id)

Set the related_sample_identity member of this class.

Parameters:

sample_id – New value for the related_sample_identity member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline const SampleIdentity &related_sample_identity() const

Get the value of the related_sample_identity member.

Returns:

Constant reference to the related_sample_identity member.

inline SampleIdentity &related_sample_identity()

Set the value of the related_sample_identity member.

Returns:

Reference to the related_sample_identity member.

inline Time_t source_timestamp() const

Get the value of the source_timestamp member.

Returns:

Current value of the source_timestamp member.

inline Time_t &source_timestamp()

Set the value of the source_timestamp member.

Returns:

Reference to the source_timestamp member.

inline WriteParams &source_timestamp(const Time_t &timestamp)

Set the source_timestamp member of this class.

Parameters:

timestamp – New value for the source_timestamp member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline WriteParams &source_timestamp(Time_t &&timestamp)

Set the source_timestamp member of this class.

Parameters:

timestamp – New value for the source_timestamp member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline std::shared_ptr<UserWriteData> user_write_data() const

Retrieves the user write data.

Returns:

Shared pointer to the user write data.

inline WriteParams &user_write_data(std::shared_ptr<UserWriteData> write_data)

Set the user write data.

Parameters:

write_data – New value for the user_write_data member.

Returns:

Reference to the modified object in order to allow daisy chaining.

inline bool has_more_replies() const
inline WriteParams &has_more_replies(bool more_replies)
inline const OriginalWriterInfo &original_writer_info() const

Get the Original Writer Info.

Returns:

Constant reference to the original_writer_info_ member.

inline OriginalWriterInfo &original_writer_info()

Get the Original Writer Info.

Returns:

Constant reference to the original_writer_info_ member.

inline WriteParams &original_writer_info(const OriginalWriterInfo &original_writer)

Set the Original Writer Info of the original writer.

Parameters:

original_writer – New value for the original_writer_info_ member.

Returns:

Reference to the modified object in order to allow daisy chaining.

Public Static Functions

static inline WriteParams write_params_default() noexcept

Default value for methods receiving a WriteParams.

Will contain the following values on its members:

Note

This should not return a reference to the static value if this value is meant to be read and written from different threads.

Public Static Attributes

static WriteParams WRITE_PARAM_DEFAULT
struct UserWriteData

Base class storing custom information in the WriteParams structure for later filtering.

This struct serves as a base class that allows derived classes to be deleted safely through a pointer to this base type. It is intended to be user-extensible.

Public Functions

UserWriteData() = default
virtual ~UserWriteData() = default