FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
FARGOS Shared Memory Functions

Implementation of integer, floating-point and string variables within shared memory segments. More...

Classes

class  SharedMemoryVariable
 Shared memory variable which allows statistics and operational controls to be exposed to other processes with minimal runtime overhead. More...
 
class  SharedMemoryVariableManager
 Manager for collection of shared memory variables. More...
 
class  SharedMemoryVariableNode
 Intermediate naming node for supporting variable naming hierarchies. More...
 
class  SMV_Numeric< NUMTYPE >
 Convenience template for creating shared memory variables of one of the supported numeric types. More...
 
class  SMV_StandaloneNumeric< NUMTYPE >
 Convenience template for creating shared memory variables of one of the supported numeric types. At the cost of additional storage, these standalone variables can operate when the variable has not been registered and allocated with a SharedMemoryVariableManager. More...
 
class  SMV_String
 Convenience class for string variables. More...
 
class  SMV_StandaloneString< MAXLEN >
 Convenience class for string variables that can be also be used if a shared memory segment is never attached. More...
 
class  SMV_StandaloneNode< MAXLEN >
 Subclass of SharedMemoryVariableNode that reserves heap space to hold data when a shared memory segment is not in use. More...
 

Macros

#define SMV_MAGIC_NUMBER   "SHMVAR01"
 Magic number used for Shared Memory Variable segments. More...
 
#define DECLARE_SMV_COUNTER(name)   SMV_Numeric<uint32_t> name(#name)
 Convenience macro to declare a shared memory counter variable. More...
 

Variables

SharedMemoryVariableManager DEFAULT_sharedMemoryVariableManager
 Default shared memory variable manager. More...
 

Detailed Description

Implementation of integer, floating-point and string variables within shared memory segments.

Macro Definition Documentation

◆ DECLARE_SMV_COUNTER

#define DECLARE_SMV_COUNTER (   name)    SMV_Numeric<uint32_t> name(#name)

Convenience macro to declare a shared memory counter variable.

Note: no support for alternate segment managers or parent naming nodes. Best used for very simple instrumentation.

◆ SMV_MAGIC_NUMBER

#define SMV_MAGIC_NUMBER   "SHMVAR01"

Magic number used for Shared Memory Variable segments.

Variable Documentation

◆ DEFAULT_sharedMemoryVariableManager

SharedMemoryVariableManager DEFAULT_sharedMemoryVariableManager

Default shared memory variable manager.

Generated: Fri Jul 31 2020 18:19:16
Support Information