Class History

• Defined in File CorePolicy.hpp

Inheritance Relationships

Base Type

• public dds::core::Value< detail::History > (Template Class Value)

Class Documentation

class History : public dds::core::Value<detail::History>

Public Functions

History(dds::core::policy::HistoryKind::Type kind = dds::core::policy::HistoryKind::KEEP_LAST, int32_t depth = 1)

Creates a History QoS instance

Parameters:

• kind – the kind

• depth – the history depth

History(const History &other)

Copies a History QoS instance

Parameters:

other – the History QoS instance to copy

dds::core::policy::HistoryKind::Type kind() const

Gets the kind

Returns:

the kind

History &kind(dds::core::policy::HistoryKind::Type kind)

Sets the kind

Parameters:

kind – the kind

int32_t depth() const

Gets the history depth

Returns:

the history depth

History &depth(int32_t depth)

Sets the history depth

Parameters:

the – history depth

Public Static Functions

static History KeepAll()

Returns:

a History QoS instance with the kind set to KEEP_ALL

static History KeepLast(uint32_t depth)

Parameters:

depth – the history depth

Returns:

a History QoS instance with the kind set to KEEP_LAST and the depth set to the supplied value