RTI Connext Modern C++ API  Version 6.1.0
rti::util::heap_monitoring::HeapMonitoringParams Class Reference

Input parameters for enabling heap monitoring. They will be used for configuring the format of the snapshot. More...

#include <util.hpp>

Inherits rti::core::NativeValueType< T, NATIVE_T, ADAPTER >.

Public Member Functions

 HeapMonitoringParams (SnapshotOutputFormat snapshot_output_format=rti::util::heap_monitoring::SnapshotOutputFormat::STANDARD, SnapshotContentFormat snapshot_content_format=rti::util::heap_monitoring::SnapshotContentFormat::DEFAULT)
 Create HeapMonitoringParams. More...
 
SnapshotOutputFormat snapshot_output_format () const
 Get the format of the output of the snapshot. More...
 
void snapshot_output_format (SnapshotOutputFormat snapshot_output_format)
 Set the format of the output of the snapshot. More...
 
SnapshotContentFormat snapshot_content_format () const
 Get the bitmap to decide which information of the snapshot will be displayed. More...
 
void snapshot_content_format (SnapshotContentFormat snapshot_content_format)
 Set the bitmap to decide which information of the snapshot will be displayed. More...
 

Detailed Description

Input parameters for enabling heap monitoring. They will be used for configuring the format of the snapshot.

<<extension>> Input parameters for enabling heap monitoring They will be used for configuring the format of the snapshot.

Constructor & Destructor Documentation

◆ HeapMonitoringParams()

rti::util::heap_monitoring::HeapMonitoringParams::HeapMonitoringParams ( SnapshotOutputFormat  snapshot_output_format = rti::util::heap_monitoring::SnapshotOutputFormat::STANDARD,
SnapshotContentFormat  snapshot_content_format = rti::util::heap_monitoring::SnapshotContentFormat::DEFAULT 
)

Create HeapMonitoringParams.

Parameters
snapshot_output_formatThe format of the output of the snapshot.
snapshot_content_formatThe bitmap to decide which information of the snapshot will be displayed.

Member Function Documentation

◆ snapshot_output_format() [1/2]

SnapshotOutputFormat rti::util::heap_monitoring::HeapMonitoringParams::snapshot_output_format ( ) const

Get the format of the output of the snapshot.

Returns
The format of the output of the snapshot

◆ snapshot_output_format() [2/2]

void rti::util::heap_monitoring::HeapMonitoringParams::snapshot_output_format ( SnapshotOutputFormat  snapshot_output_format)

Set the format of the output of the snapshot.

Parameters
snapshot_output_formatThe format of the output of the snapshot

◆ snapshot_content_format() [1/2]

SnapshotContentFormat rti::util::heap_monitoring::HeapMonitoringParams::snapshot_content_format ( ) const

Get the bitmap to decide which information of the snapshot will be displayed.

Returns
The bitmap to decide which information of the snapshot will be displayed.

◆ snapshot_content_format() [2/2]

void rti::util::heap_monitoring::HeapMonitoringParams::snapshot_content_format ( SnapshotContentFormat  snapshot_content_format)

Set the bitmap to decide which information of the snapshot will be displayed.

Parameters
snapshot_content_formatThe bitmap to decide which information of the snapshot will be displayed.