Table structure. More...

#include <aida_pva_types.h>

Data Fields
int	_currentColumn
	For internal use by addColumn() etc. More...

int	_currentField
	For internal use by addField() etc. More...

int	_currentLabel
	For internal use by addLabel() etc. More...

int	columnCount
	number of columns in table More...

void **	ppData
	the data. an array of [rows][columns] More...

char **	ppFields
	the overridden field names. if null, not overridden. If not null then array of pointers to allocated strings More...

char **	ppLabels
	the overridden label names. if null, not overridden. If not null then array of pointers to allocated strings More...

int	rowCount
	number of rows in table More...

Type *	types
	the scalar type of each column, one of BOOLEAN, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, or STRING More...

Detailed Description

Table structure.

This structure holds everything that a Native Channel Provider needs for returning a Table to the client. A table is a set of homogeneously sized vectors representing columns of data. The configuration of the table (labels, names, descriptions, etc) is handled outside of the Native Channel Provider, so all the implementation needs to do is provide the raw data for the columns.

See also

Implementors don't manipulate these structures directly as ../../../docs/4_0_AIDA-PVA_Module.md "AIDA-PVA Module" provides table manipulation functions:

Definition at line 157 of file aida_pva_types.h.

Field Documentation

◆ _currentColumn

int _currentColumn

For internal use by addColumn() etc.

Definition at line 165 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddStringColumn(), tableCreate(), and toTable().

◆ _currentField

int _currentField

For internal use by addField() etc.

Definition at line 166 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddField(), tableCreateDynamic(), and toTable().

◆ _currentLabel

int _currentLabel

For internal use by addLabel() etc.

Definition at line 167 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddLabel(), tableCreateDynamic(), and toTable().

◆ columnCount

int columnCount

number of columns in table

Definition at line 159 of file aida_pva_types.h.

Referenced by aidaRequestTable(), releaseTable(), tableAddColumn(), tableAddField(), tableAddLabel(), and tableCreate().

◆ ppData

void** ppData

the data. an array of [rows][columns]

Definition at line 162 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddStringColumn(), tableCreate(), and toTable().

◆ ppFields

char** ppFields

the overridden field names. if null, not overridden. If not null then array of pointers to allocated strings

Definition at line 163 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddField(), tableCreateDynamic(), and toTable().

◆ ppLabels

char** ppLabels

the overridden label names. if null, not overridden. If not null then array of pointers to allocated strings

Definition at line 164 of file aida_pva_types.h.

Referenced by releaseTable(), tableAddLabel(), tableCreateDynamic(), and toTable().

◆ rowCount

int rowCount

number of rows in table

Definition at line 160 of file aida_pva_types.h.

Referenced by tableAddColumn(), tableAddFixedWidthStringColumn(), tableAddStringColumn(), tableCreate(), and toTable().

◆ types

Type* types

the scalar type of each column, one of BOOLEAN, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, or STRING

Definition at line 161 of file aida_pva_types.h.

Referenced by releaseTable(), tableCreate(), and toTable().

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

root/cpp/include/aida_pva_types.h

Data Fields