xsil::dim Class Reference
[Xsil document preparation]

#include <dim.hh>

Inheritance diagram for xsil::dim:

List of all members.

Public Member Functions
	dim (void)
	dim (const char *Name, int N)
	~dim (void)
void	Spew (Xwriter &xout) const
dim *	Clone (void) const
const char *	getObjType (void) const
int	getDim (void) const
void	setDim (int Dim)

---

Detailed Description

xsil::dim carries the XSIL Array object's dimension information. brief Array dimension class.

Author:

J. Zweizig

Version:

1.1; Modified December 13, 1999

---

Constructor & Destructor Documentation

xsil::dim::dim

(

void

)

Default constructor.

xsil::dim::dim	(	const char *	Name,
		int	N
	)

Construct an object with a non-zero dimension size and an optional name. If the name is coded as a null pointer, the name attribute is left blank. brief Full dimension constructor.

xsil::dim::~dim

(

void

)

Destructor.

---

Member Function Documentation

void xsil::dim::Spew

(

Xwriter &

xout

)

const [virtual]

The dimension object is written to an XML output stream specified by the argument object. The calling sequesnce is kept compatible with the xobj abstract class in case it is decided that dim should inherit xobj; brief Write out the dimension object to an XML file.

Parameters:

xout

XML writer to which the dimension is to be written.

Implements xsil::xobj.

dim* xsil::dim::Clone

(

void

)

const [virtual]

Clone a dimension object. brief Get object type.

Returns:

Object type;

Implements xsil::xobj.

const char* xsil::dim::getObjType

(

void

)

const [virtual]

Returns a charater string "Dim" representing the object type. brief Get object type.

Returns:

Object type;

Implements xsil::xobj.

int xsil::dim::getDim

(

void

)

const

Get the dimension length. Returns aninteger length for this dimension.

void xsil::dim::setDim

(

int

Dim

)

Set the dimension. Set the dimension length to the integer argument value.

---

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

• xsil/dim.hh

---