gmslLibrary.Services.DataTable Class Reference

The class DataTable uses the Write class to produce structured tabular reports using the content of the runtime data queue. The reports themselves can be produced in one of three outputStyles: simple tab delimited, text tabular, or html tabular. More...

Static Public Member Functions
static void	ClearBottom ()
	The method ClearBottom checks to see if there is a bottom mark at the current top of the data queue. If there is, then it removes that mark. If there is not, then it or issues a fatal system error. More...
static void	DefineColumn (string heading, int width)
	The method DefineColumn sets up the calls to the method WriteHeadings which expects to find a series of (String, Integer) pairs in the data queue. The number of pairs defines the number of columns in the table, each string entry defines the column heading, and the integer entry defines the field width and orientation to be used as follows: a positive value of "n" means to right justify the characters in a cell n characters wide; and an negative value of "n" means to left justify the characters in a cell n characters wide. These values are actually only used when the otput syntax is text tabular; however, since this syntax choice does not take effect until runtime, the values should always be supplied with reasonable values. More...
static void	SetBottom ()
	The method SetBottom marks the current spot in the queue as the current bottom. Any attempt to pop value from the queue will fail until this mark is cleared. This method is needed to block any interference between the DataTable class and the other classes using the data queue. More...
static void	WriteCell ()
	The method WriteCell writes the current table cell. In many complex output situations it is often desirable to nest the output support utilities so that complex outputs can be nested within each other or can be constructed with independent sets of logic. This method allows for the writing of complex data cells within data tables. Rather than writing the current output record and thus clearing its internal buffers so that another record can be written, this method pushes the content of the internal buffer onto the runtime data queue and then clears the buffer. More...
static void	WriteClose ()
	The method WriteClose writes the page closing portion of an html page that was being used to contain data tables. More...
static void	WriteEnd ()
	The method WriteEnd writes the end portion of an html data table and ends the centering associated with it. More...
static void	WriteHeadings ()
	The method WriteHeadingswrites a column heading to the currently active tabular display using the table style specified when the table display was started. The heading and their desired widths themselves are stored in the runtime data queue via the method DefineColumn. More...
static void	WriteOpen ()
	The method WriteOpen writes the page opening portion of an html page that will be containing data tables. More...
static void	WriteRow ()
	The method WriteRow writes a data row to the currently active data table using the table style specified when the table display was started. The cell content making up the data raw are stored as strings on the runtime data queue. More...
static void	WriteTitle ()
	The method WriteTitle writes a title for a table of values along with other control information that may be needed to begin the actual table display to the currently active output stream using the form required by the output syntax being used for it. The title itself is stored on the runtime data queue prior to the call to this method. More...

Detailed Description

The class DataTable uses the Write class to produce structured tabular reports using the content of the runtime data queue. The reports themselves can be produced in one of three outputStyles: simple tab delimited, text tabular, or html tabular.

Member Function Documentation

ClearBottom()

static void gmslLibrary.Services.DataTable.ClearBottom ( )

static

The method ClearBottom checks to see if there is a bottom mark at the current top of the data queue. If there is, then it removes that mark. If there is not, then it or issues a fatal system error.

DefineColumn()

static void gmslLibrary.Services.DataTable.DefineColumn ( string  heading, int  width  )

static

The method DefineColumn sets up the calls to the method WriteHeadings which expects to find a series of (String, Integer) pairs in the data queue. The number of pairs defines the number of columns in the table, each string entry defines the column heading, and the integer entry defines the field width and orientation to be used as follows: a positive value of "n" means to right justify the characters in a cell n characters wide; and an negative value of "n" means to left justify the characters in a cell n characters wide. These values are actually only used when the otput syntax is text tabular; however, since this syntax choice does not take effect until runtime, the values should always be supplied with reasonable values.

Parameters

heading	On each call to this method the parameter heading supplies the heading for the next column.
width	On each call the parameter width supplies the width for the next column.

SetBottom()

static void gmslLibrary.Services.DataTable.SetBottom ( )

static

The method SetBottom marks the current spot in the queue as the current bottom. Any attempt to pop value from the queue will fail until this mark is cleared. This method is needed to block any interference between the DataTable class and the other classes using the data queue.

WriteCell()

static void gmslLibrary.Services.DataTable.WriteCell ( )

static

The method WriteCell writes the current table cell. In many complex output situations it is often desirable to nest the output support utilities so that complex outputs can be nested within each other or can be constructed with independent sets of logic. This method allows for the writing of complex data cells within data tables. Rather than writing the current output record and thus clearing its internal buffers so that another record can be written, this method pushes the content of the internal buffer onto the runtime data queue and then clears the buffer.

WriteClose()

static void gmslLibrary.Services.DataTable.WriteClose ( )

static

The method WriteClose writes the page closing portion of an html page that was being used to contain data tables.

WriteEnd()

static void gmslLibrary.Services.DataTable.WriteEnd ( )

static

The method WriteEnd writes the end portion of an html data table and ends the centering associated with it.

WriteHeadings()

static void gmslLibrary.Services.DataTable.WriteHeadings ( )

static

The method WriteHeadingswrites a column heading to the currently active tabular display using the table style specified when the table display was started. The heading and their desired widths themselves are stored in the runtime data queue via the method DefineColumn.

WriteOpen()

static void gmslLibrary.Services.DataTable.WriteOpen ( )

static

The method WriteOpen writes the page opening portion of an html page that will be containing data tables.

WriteRow()

static void gmslLibrary.Services.DataTable.WriteRow ( )

static

The method WriteRow writes a data row to the currently active data table using the table style specified when the table display was started. The cell content making up the data raw are stored as strings on the runtime data queue.

WriteTitle()

static void gmslLibrary.Services.DataTable.WriteTitle ( )

static

The method WriteTitle writes a title for a table of values along with other control information that may be needed to begin the actual table display to the currently active output stream using the form required by the output syntax being used for it. The title itself is stored on the runtime data queue prior to the call to this method.

---

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

• C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/DataTable.cs