Main Page | Features | Central Services | csv-Files | Types | Transfer | Access | API-C | API-.NET | API-Java | Examples | Downloads
page generated on 09.11.2024 - 04:45
Data Fields
PrpQueryStruct Struct Reference

Defines the definitive (non-legacy) property query structure. More...

#include <tinetype.h>

Data Fields

UINT16 numRows
 
BYTE prpAccess
 
UINT16 prpArrayType
 
char prpDescription [PROPERTY_DESC_SIZE]
 
BYTE prpFormat
 
BYTE prpFormatIn
 
BYTE prpGraphType
 
UINT16 prpHistoryDepthLong
 
UINT16 prpHistoryDepthShort
 
float prpMaxValue
 
float prpMinValue
 
char prpName [PROPERTY_NAME_SIZE]
 
UINT32 prpNumOverloads
 
char prpRedirection [PROPERTY_REDIR_SIZE]
 
UINT32 prpSize
 
UINT32 prpSizeIn
 
char prpTag [TAG_NAME_SIZE]
 
char prpTagIn [TAG_NAME_SIZE]
 
char prpUnits [UNITS_SIZE]
 
UINT16 reserved [3]
 
float rngMaxValue
 
float rngMinValue
 
char rngUnits [UNITS_SIZE]
 
UINT16 rowSize
 

Detailed Description

Defines the definitive (non-legacy) property query structure.

Field Documentation

◆ numRows

UINT16 PrpQueryStruct::numRows

the number of rows in an array property

◆ prpAccess

BYTE PrpQueryStruct::prpAccess

the allowed data access for this property (either CA_READ, CA_WRITE or both)

◆ prpArrayType

UINT16 PrpQueryStruct::prpArrayType

the property array type (AT_NONE, AT_SCALAR, AT_CHANNEL, AT_SPECTRUM, etc.)

◆ prpDescription

char PrpQueryStruct::prpDescription[PROPERTY_DESC_SIZE]

the property description

◆ prpFormat

BYTE PrpQueryStruct::prpFormat

the default output data format accepted for this property

◆ prpFormatIn

BYTE PrpQueryStruct::prpFormatIn

is the default input data format accepted for this property

◆ prpGraphType

BYTE PrpQueryStruct::prpGraphType

is the preferred graph type for output data associated with this property, e.g. GT_LIN, GT_LOG, etc

◆ prpHistoryDepthLong

UINT16 PrpQueryStruct::prpHistoryDepthLong

the depth of the long term history kept for this property

◆ prpHistoryDepthShort

UINT16 PrpQueryStruct::prpHistoryDepthShort

the depth of the short term history kept for this property

◆ prpMaxValue

float PrpQueryStruct::prpMaxValue

the upper limit of valid data associated with the property

◆ prpMinValue

float PrpQueryStruct::prpMinValue

the lower limit of valid data associated with the property

◆ prpName

char PrpQueryStruct::prpName[PROPERTY_NAME_SIZE]

the property name

◆ prpNumOverloads

UINT32 PrpQueryStruct::prpNumOverloads

the number of overloads associated with this property name

◆ prpRedirection

char PrpQueryStruct::prpRedirection[PROPERTY_REDIR_SIZE]

a redirection string if the property is redirected to another server

◆ prpSize

UINT32 PrpQueryStruct::prpSize

the maximum allowed size of an output data set associated with the property

◆ prpSizeIn

UINT32 PrpQueryStruct::prpSizeIn

the maximum allowed size of an input data set associated with the property

◆ prpTag

char PrpQueryStruct::prpTag[TAG_NAME_SIZE]

the data tag for output data sets (CF_STRUCT, CF_BITFIELD, CF_HISTORY, etc.)

◆ prpTagIn

char PrpQueryStruct::prpTagIn[TAG_NAME_SIZE]

the data tag for input data sets (CF_STRUCT, CF_BITFIELD, CF_HISTORY, etc.)

◆ prpUnits

char PrpQueryStruct::prpUnits[UNITS_SIZE]

a string containing the natural units of the data returned by the property

◆ reserved

UINT16 PrpQueryStruct::reserved[3]

reserved field)

◆ rngMaxValue

float PrpQueryStruct::rngMaxValue

the upper limit of x-axis range associated with the property

◆ rngMinValue

float PrpQueryStruct::rngMinValue

the lower limit of x-axis range associated with the property

◆ rngUnits

char PrpQueryStruct::rngUnits[UNITS_SIZE]

a string containing the natural units of the x-axis (range) in case of a spectrum type array

◆ rowSize

UINT16 PrpQueryStruct::rowSize

the size of a row in an array property


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

Impressum   |   Imprint   |   Datenschutzerklaerung   |   Data Privacy Policy   |   Declaration of Accessibility   |   Erklaerung zur Barrierefreiheit
Generated for TINE API by  doxygen 1.5.8