SIMulation Workbench Documentation SIMulation Workbench Documentation

RTDBItemMeta Struct Reference
[RTDB Access API]

#include <simrtdb.h>

Public Member Functions

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
struct {
aligned
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

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

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

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

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

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

Set when conversion raw to physical can not be inverted.

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

Field Documentation

Index # in hash table for this item

Index # in RTDB table for this item

struct { ... } RTDBItemMeta::aligned

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

'C' Data type for the corresponding raw value.

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

Size of an element value in byte.

int RTDBItemMeta::dimensions[MAX_DIMENSIONS]

Dimension of the data point

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

Maximum value allowed for this item

Minimum value allowed for this item

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

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

The maximum length in bytes for the string variable.

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

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

unsigned int RTDBItemMeta::uSecToDB

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

Meta flags for this data items. One of METAFL_xxx.

See also:
RTDB_MetaFLags
unsigned short RTDBItemMeta::euMsgPeriod

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

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

Class for the unit if defined

unsigned char RTDBItemMeta::unitClass

Class for the unit if defined

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.

Index into EU conversion record table

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.

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

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

The number of out channels to shutdown for this item.

This Item has an end value .

This is a spare item.


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