ODBC Tapes
[Players and recorders (tape)]

---

Detailed Description

ODBC-type tapes work on databases.

The filename field is used as the command line to access and log into a database using ODBC (Open Database Connectivity). Anonymous transactions are allowed by the module, but are dependent on the database. The ODBC model relies on locating a HEADER_TABLE, OBJECT_TABLE, and an EVENT_TABLE in the database. Objects are written in mostly as a series of text fields.

HEADER_TABLE

• HEADER_OBJECT_NAME - Text - The name of the referenced tape
• HEADER_TIME - Text - Asctime() that the tape was opened
• HEADER_USER - Text - Local computer username
• HEADER_HOST - Text - Local computer hostname
• HEADER_TARGET - Text - Target field for this tape, either and object name or aggregate definition
• HEADER_PROPERTY - Text - Property field for this tape
• HEADER_INTERVAL - Number - Interval for this tape recording values (-1 == on change)
• HEADER_LIMIT - Number - Maximum number of lines written for this tape

OBJECT_TABLE and EVENT_TABLE

• EVENT_OBJECT_NAME - Text - Name of the tape object that wrote this line
• EVENT_LINE - Number - Nth line written to or to be read by the tape
• EVENT_TIME - Text - Timedate of the event, either in relative or absolute (YYYY-MM-DD HH:MM:SS) format
• EVENT_VAL - Text - Value written or read to the target. Text for a double, complex, or enumeration.

Future implimentations may change drastically.

Functions
void	close_collector (struct collector *my)
void	close_player (struct player *my)
void	close_recorder (struct recorder *my)
void	close_shaper (struct shaper *my)
int	open_collector (struct collector *my, char *fname, char *flags)
int	open_player (struct player *my, char *fname, char *flags)
int	open_recorder (struct recorder *my, char *fname, char *flags)
int	open_shaper (struct shaper *my, char *fname, char *flags)
char *	read_player (struct player *my, char *buffer, unsigned int size)
char *	read_shaper (struct shaper *my, char *buffer, unsigned int size)
int	rewind_player (struct player *my)
int	rewind_shaper (struct shaper *my)
int	write_collector (struct collector *my, char *timestamp, char *value)
int	write_recorder (struct recorder *my, char *timestamp, char *value)
Variables
EXPORT CALLBACKS *	callback = NULL

---

Function Documentation

int open_shaper	(	struct shaper *	my,
		char *	fname,
		char *	flags
	)

Todo:

finish write memory shaper -- it still uses files (no ticket)

Todo:

shape defaults should be read from the shape memory, or better yet, inferred from it (no ticket)

Definition at line 65 of file tape_odbc.cpp.

References file, shaper::fp, FT_FILE, gl_error, shaper::interval, ISSET, min, shaper::scale, shaper::shape, shaper::status, shaper::step, TS_DONE, TS_OPEN, and shaper::type.

---

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy