xsil::table Class Reference
[Xsil document preparation]

#include <table.hh>

Inheritance diagram for xsil::table:

List of all members.

Public Member Functions
	table (void)
	table (const char *Name, const char *Type=0)
	table (const table &x)
virtual	~table (void)
void	Spew (Xwriter &xout) const
virtual table *	Clone (void) const
bool	empty (void) const
const char *	getObjType (void) const
const char *	getUnit (void) const
column *	addColumn (const char *Name, const char *Type=0, const char *Unit=0)
column *	addColumn (const column &col)
column &	refColumn (const char *name)
const column &	refColumn (const char *name) const
Stream &	refStream (void)
const Stream &	refStream (void) const
void	setStream (const Stream &istr)
void	setUnit (const char *Unit)

---

Detailed Description

This class defines tables to be output in XSIL. brief XSIL table class.

Author:

J. Zweizig

Version:

1.1; Modified December 13, 1999.

---

Constructor & Destructor Documentation

xsil::table::table

(

void

)

XSil table default constructor. brief default constructor.

xsil::table::table	(	const char *	Name,
		const char *	Type = 0
	)

Named table constructor. brief Named table constructor.

xsil::table::table

(

const table &

x

)

Named table constructor. brief Named table constructor.

virtual xsil::table::~table

(

void

)

[virtual]

XSil table destructor. brief Deconstructor.

---

Member Function Documentation

void xsil::table::Spew

(

Xwriter &

xout

)

const [virtual]

Write an XSil table definition to an XML output file. brief Write table to an XML file.

Parameters:

xout

XML output file to receive the table definition.

Implements xsil::xobj.

virtual table* xsil::table::Clone

(

void

)

const [virtual]

Clone an XSIL table definition. brief Clone a table object.

Returns:

Pointer to the cloned object.

Implements xsil::xobj.

bool xsil::table::empty

(

void

)

const [inline]

Test for data in the table.

Returns:

true if the table (data stream) is empty.

const char* xsil::table::getObjType

(

void

)

const [virtual]

Get the XSIL object type. brief Get object type.

Returns:

Pointer to the object type string.

Implements xsil::xobj.

const char * xsil::table::getUnit

(

void

)

const [inline]

Get table units brief get Table units.

Returns:

Pointer to string containing the Table units.

column* xsil::table::addColumn	(	const char *	Name,
		const char *	Type = 0,
		const char *	Unit = 0
	)

Add a column to the table. brief Add a column.

Parameters:

	Name	Pointer to column name string.
	Type	Pointer to column type string.
	Unit	Pointer to column unit string.

Returns:

Pointer to added column.

column* xsil::table::addColumn

(

const column &

col

)

Add a column to the table. brief Add a column.

Parameters:

col

Column definition to be added to table.

Returns:

Pointer to added column.

column& xsil::table::refColumn

(

const char *

name

)

Get reference to the specified column. brief Reference a column.

Returns:

reference to the name column.

const column& xsil::table::refColumn

(

const char *

name

)

const

Get reference to the specified column. brief Reference a column.

Parameters:

name

Pointer to string with requested name.

Returns:

reference to the name column.

xsil::Stream & xsil::table::refStream

(

void

)

[inline]

Get reference to an initialization stream. brief Reference initialization stream.

Returns:

reference to the initialization stream.

const xsil::Stream & xsil::table::refStream

(

void

)

const [inline]

Get reference to an initialization stream. brief Reference initialization stream.

Returns:

reference to the initialization stream.

void xsil::table::setStream

(

const Stream &

istr

)

Add a stream to the array. brief Add a stream to the array.

Parameters:

istr

Stream object to be added to the array.

void xsil::table::setUnit

(

const char *

Unit

)

Set the table units. brief Set the table units.

Parameters:

Unit

Pointer to table unit string.

---

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

• xsil/table.hh

---