FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
SharedMemoryVariable::SharedMemoryVariable_Record Struct Referencefinal

Storage layout for shared memory variable record within a memory mapped segment. More...

#include <shared_variable.hpp>

Public Member Functions

char * formatAsText (char *bfr, uint_fast32_t bfrLen, uint_fast32_t displayMode, const char *pathPrefix=nullptr, bool isNative=true) const
 Format variable into text buffer. More...
 
int getPathPrefix (char *bfr, uint_fast32_t bfrLen, unsigned char *base, bool isNative=true) const
 Get parent path name of variable. More...
 

Public Attributes

union {
   uint64_t   u64
 
   int64_t   i64
 
   int32_t   i32
 
   uint32_t   u32
 
   float   f
 
   double   d
 
   char   tinyString [8]
 
numericValue
 
uint64_t parentNodeOffset
 
uint32_t allocatedLength
 allocated length More...
 
uint32_t usedLength
 used length, always <= allocated length More...
 
uint16_t recordType
 type of record, see SharedMemoryVariableType More...
 
uint16_t varNameLength
 strlen() + 1; includes null in count More...
 
char varName [12+sizeof(SharedBufferAllocRecord)]
 variable name More...
 

Detailed Description

Storage layout for shared memory variable record within a memory mapped segment.

Note: all data in this record must be able to be interpreted regardless of address space.

Member Function Documentation

◆ formatAsText()

◆ getPathPrefix()

int SharedMemoryVariable::SharedMemoryVariable_Record::getPathPrefix ( char *  bfr,
uint_fast32_t  bfrLen,
unsigned char *  base,
bool  isNative = true 
) const

Get parent path name of variable.

References GET16_NATIVE, GET64_NATIVE, parentNodeOffset, varName, and varNameLength.

Member Data Documentation

◆ allocatedLength

◆ d

double SharedMemoryVariable::SharedMemoryVariable_Record::d

Referenced by formatAsText().

◆ f

float SharedMemoryVariable::SharedMemoryVariable_Record::f

Referenced by formatAsText().

◆ i32

int32_t SharedMemoryVariable::SharedMemoryVariable_Record::i32

◆ i64

int64_t SharedMemoryVariable::SharedMemoryVariable_Record::i64

◆ numericValue

union { ... } SharedMemoryVariable::SharedMemoryVariable_Record::numericValue

Referenced by formatAsText().

◆ parentNodeOffset

uint64_t SharedMemoryVariable::SharedMemoryVariable_Record::parentNodeOffset

◆ recordType

uint16_t SharedMemoryVariable::SharedMemoryVariable_Record::recordType

◆ tinyString

char SharedMemoryVariable::SharedMemoryVariable_Record::tinyString[8]

◆ u32

uint32_t SharedMemoryVariable::SharedMemoryVariable_Record::u32

◆ u64

uint64_t SharedMemoryVariable::SharedMemoryVariable_Record::u64

◆ usedLength

uint32_t SharedMemoryVariable::SharedMemoryVariable_Record::usedLength

◆ varName

◆ varNameLength


The documentation for this struct was generated from the following files:
Generated: Tue Jul 28 2020 16:03:27
Support Information