Real-Time API Revision2025.1-3
Loading...
Searching...
No Matches
RTDBItemMeta Struct Reference

#include <simrtdb.h>

Public Member Functions

struct { 
__attribute__ ((aligned(8)))
unsigned long long tickLastUpdate __attribute__ ((aligned(8)))
char *euConversionName __attribute__ ((aligned(8)))
int euConversionError __attribute__ ((aligned(8)))
char mappingResolved __attribute__ ((aligned(8)))

Data Fields

int hashTableIndex
int rtdbItemIndex
short pointType
short rawType
short cvtType
short valueSize
int dimensions [MAX_DIMENSIONS]
int numElements
float euMaxValue
float euMinValue
int stringIndex
int altStringIndex
int maxStringLength
int cvtOffset
int loggingPeriod
unsigned int uSecToDB
unsigned int metaFlags
unsigned short euMsgPeriod
unsigned int updateIntervalUSec
short unitIndex
unsigned char unitClass
int rawOffset [MAX_IOMAPPINGS]
int euConversionIndex
short ioTableIndex [MAX_IOMAPPINGS]
float shutDownRate
float endValue
short endCount
char hasEndValue
char isSpare

Detailed Description

Meta data only for a RTDB item. All those are specified as part of the definition of a RTDB item. This does not contain anything related to the value of an item.

Member Function Documentation

◆ __attribute__() [1/5]

struct RTDBItemMeta::@175275064040352211123360151102266267071343211211 RTDBItemMeta::__attribute__ ( (aligned(8)) )

◆ __attribute__() [2/5]

unsigned long long tickLastUpdate RTDBItemMeta::__attribute__ ( (aligned(8)) )

ARINC 429 input points only. Tick when this item was last updated.

◆ __attribute__() [3/5]

char *euConversionName RTDBItemMeta::__attribute__ ( (aligned(8)) )

EU conversion record name.Only valid in static non-shared record when creating the record.

◆ __attribute__() [4/5]

int euConversionError RTDBItemMeta::__attribute__ ( (aligned(8)) )

Set when conversion raw to physical can not be inverted.

◆ __attribute__() [5/5]

char mappingResolved RTDBItemMeta::__attribute__ ( (aligned(8)) )

Field Documentation

◆ hashTableIndex

int RTDBItemMeta::hashTableIndex

Index # in hash table for this item

◆ rtdbItemIndex

int RTDBItemMeta::rtdbItemIndex

Index # in RTDB table for this item

◆ pointType

short RTDBItemMeta::pointType

Point type (RTDBAI,RTDBAO,....)

◆ rawType

short RTDBItemMeta::rawType

'C' Data type for the corresponding raw value.

◆ cvtType

short RTDBItemMeta::cvtType

'C' Data type for the data in the CVT table

◆ valueSize

short RTDBItemMeta::valueSize

Size of an element value in byte.

◆ dimensions

int RTDBItemMeta::dimensions[MAX_DIMENSIONS]

Dimension of the data point

◆ numElements

int RTDBItemMeta::numElements

Number of elements in vector including all dimensions. I.e. 4 if this is a 2X2 matrix.

◆ euMaxValue

float RTDBItemMeta::euMaxValue

Maximum value allowed for this item

◆ euMinValue

float RTDBItemMeta::euMinValue

Minimum value allowed for this item

◆ stringIndex

int RTDBItemMeta::stringIndex

For string variable only. This points to the location of the value of this string variable in the string table.

◆ altStringIndex

int RTDBItemMeta::altStringIndex

For string variable only. This points to the location of the alternate value of this string variable in the string table.

◆ maxStringLength

int RTDBItemMeta::maxStringLength

The maximum length in bytes for the string variable.

◆ cvtOffset

int RTDBItemMeta::cvtOffset

Offset in cvt struct where the value of this item resides. For arrays, values are contiguous in the CVT and alternate value table.

◆ loggingPeriod

int RTDBItemMeta::loggingPeriod

In us, how often we log the value of this item to historical file.

◆ uSecToDB

unsigned int RTDBItemMeta::uSecToDB

For async input points, time in usec between the interrupt and the write to the RTDB.

◆ metaFlags

unsigned int RTDBItemMeta::metaFlags

Meta flags for this data items. One of METAFL_xxx.

See also
RTDB_MetaFLags

◆ euMsgPeriod

unsigned short RTDBItemMeta::euMsgPeriod

Maximum rate in second at which to issue repeated EU out of range messages.

◆ updateIntervalUSec

unsigned int RTDBItemMeta::updateIntervalUSec

ARINC 429 input points only. Time interval between last two succesive updates.

◆ unitIndex

short RTDBItemMeta::unitIndex

Class for the unit if defined

◆ unitClass

unsigned char RTDBItemMeta::unitClass

Class for the unit if defined

◆ rawOffset

int RTDBItemMeta::rawOffset[MAX_IOMAPPINGS]

Offset to raw value in raw value table. Need one per mapping for output points since each device might compute a different value.

◆ euConversionIndex

int RTDBItemMeta::euConversionIndex

Index into EU conversion record table

◆ ioTableIndex

short RTDBItemMeta::ioTableIndex[MAX_IOMAPPINGS]

Index into arinc429 table or CAN id table when this point is mapped to an output arinc 429 label or CAN Id.

◆ shutDownRate

float RTDBItemMeta::shutDownRate

Shutdown rate in EU/s to reach the shutdown condition on output.

◆ endValue

float RTDBItemMeta::endValue

End value for the item at the end of the test.

◆ endCount

short RTDBItemMeta::endCount

The number of out channels to shutdown for this item.

◆ hasEndValue

char RTDBItemMeta::hasEndValue

This Item has an end value .

◆ isSpare

char RTDBItemMeta::isSpare

This is a spare item.


The documentation for this struct was generated from the following file: