RTI Connext Modern C++ API  Version 6.0.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::AllocationSettings Class Reference

<<extension>> Resource allocation settings More...

#include <rti/core/AllocationSettings.hpp>

Public Member Functions

 AllocationSettings ()
 Creates an instance with an initial, max and incremental count set to zero.
 
 AllocationSettings (int32_t the_initial_count, int32_t the_max_count, int32_t the_incremental_count)
 Creates an instance with the given initial, maximum and incremental values.
 
int32_t initial_count () const
 Getter (see setter with the same name)
 
AllocationSettingsinitial_count (int32_t the_initial_count)
 Sets the initial count of resources.
 
int32_t max_count () const
 Getter (see setter with the same name)
 
AllocationSettingsmax_count (int32_t the_max_count)
 Sets the maximum count of resources.
 
int32_t incremental_count () const
 Getter (see setter with the same name)
 
AllocationSettingsincremental_count (int32_t the_incremental_count)
 Sets the incremental count of resources.
 

Static Public Attributes

static const int32_t AUTO_COUNT = -2
 A special value indicating that the quantity is derived from a different Qos value.
 

Detailed Description

Constructor & Destructor Documentation

rti::core::AllocationSettings::AllocationSettings ( )
inline

Creates an instance with an initial, max and incremental count set to zero.

rti::core::AllocationSettings::AllocationSettings ( int32_t  the_initial_count,
int32_t  the_max_count,
int32_t  the_incremental_count 
)
inline

Creates an instance with the given initial, maximum and incremental values.

Member Function Documentation

int32_t rti::core::AllocationSettings::initial_count ( ) const
inline

Getter (see setter with the same name)

AllocationSettings& rti::core::AllocationSettings::initial_count ( int32_t  the_initial_count)
inline

Sets the initial count of resources.

The initial resources to be allocated.

[default] It depends on the case.

[range] [0, 1 million], < max_count, (or = max_count only if increment_count == 0)

int32_t rti::core::AllocationSettings::max_count ( ) const
inline

Getter (see setter with the same name)

AllocationSettings& rti::core::AllocationSettings::max_count ( int32_t  the_max_count)
inline

Sets the maximum count of resources.

The maximum resources to be allocated.

[default] Depends on the case.

[range] [1, 1 million] or dds::core::LENGTH_UNLIMITED, > initial_count (or = initial_count only if increment_count == 0)

int32_t rti::core::AllocationSettings::incremental_count ( ) const
inline

Getter (see setter with the same name)

AllocationSettings& rti::core::AllocationSettings::incremental_count ( int32_t  the_incremental_count)
inline

Sets the incremental count of resources.

The resource to be allocated when more resources are needed.

[default] Depends on the case.

[range] -1 (Double the amount of extra memory allocated each time memory is needed) or [1,1 million] (or = 0 only if initial_count == max_count)

Member Data Documentation

const int32_t rti::core::AllocationSettings::AUTO_COUNT = -2
static

A special value indicating that the quantity is derived from a different Qos value.


RTI Connext Modern C++ API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc