MaxHistorySize Class Reference

#include <RobotAPI/libraries/armem/server/wm/detail/MaxHistorySize.h>

+ Inheritance diagram for MaxHistorySize:

Public Member Functions

long getMaxHistorySize () const
 
void setMaxHistorySize (long maxSize, const std::string &additionalInfo="")
 Set the maximum number of snapshots to be contained in an entity. More...
 

Protected Attributes

long _maxHistorySize = -1
 Maximum size of entity histories. More...
 

Detailed Description

Definition at line 7 of file MaxHistorySize.h.

Member Function Documentation

◆ getMaxHistorySize()

long getMaxHistorySize ( ) const

Definition at line 26 of file MaxHistorySize.cpp.

+ Here is the caller graph for this function:

◆ setMaxHistorySize()

void setMaxHistorySize ( long  maxSize,
const std::string &  additionalInfo = "" 
)

Set the maximum number of snapshots to be contained in an entity.

Affected entities are to be update right away.

Definition at line 8 of file MaxHistorySize.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ _maxHistorySize

long _maxHistorySize = -1
protected

Maximum size of entity histories.

If negative, the size of history is not limited.

See also
Entity::maxHstorySize

Definition at line 29 of file MaxHistorySize.h.


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