xsil::param Class Reference
[Xsil document preparation]

#include <param.hh>

Inheritance diagram for xsil::param:

List of all members.

Public Member Functions
	param (void)
	param (const char *Name, const char *Type=0, const char *Unit=0, const char *Value=0)
	param (const char *Name, const char *Unit, double Value)
	param (const char *Name, const char *Unit, int Value)
	~param (void)
void	Spew (Xwriter &xout) const
param *	Clone (void) const
const char *	getObjType (void) const
const char *	getUnit (void) const
const char *	getValue (void) const
void	setUnit (const char *Unit)
void	setValue (const std::string &Value)
void	setValue (double Value)
void	setValue (unsigned int Value)
void	setValue (int Value)
void	setValue (const char *Value)

---

Detailed Description

xsil::param defines parameter objects in an xsil structure. brief XSIL parameter class.

Author:

J. Zweizig

Version:

1.1; Modified December 13, 1999

---

Constructor & Destructor Documentation

xsil::param::param

(

void

)

Create an unnamed, untyped parameter. brief Default constructor.

xsil::param::param	(	const char *	Name,
		const char *	Type = 0,
		const char *	Unit = 0,
		const char *	Value = 0
	)

Create a constructor with the specified name, type, and units. Any of the arguments may be set to a null string by coding 0 instead of a character string pointer. brief Param constructor.

Parameters:

	Name	Pointer to parameter name string.
	Type	Pointer to parameter type string.
	Unit	Pointer to parameter unit string.
	Value	Pointer to the parameter value string.

xsil::param::param	(	const char *	Name,
		const char *	Unit,
		double	Value
	)

Create a constructor with the specified name, type, and units, and a numeric value. Any of the string arguments may be set to a null by coding 0 instead of a character string pointer. brief Param constructor.

Parameters:

	Name	Pointer to parameter name string.
	Unit	Pointer to parameter unit string.
	Value	Parameter value.

xsil::param::param	(	const char *	Name,
		const char *	Unit,
		int	Value
	)

Create a constructor with the specified name, type, and units, and a numeric value. Any of the string arguments may be set to a null by coding 0 instead of a character string pointer. brief Param constructor.

Parameters:

	Name	Pointer to parameter name string.
	Unit	Pointer to parameter unit string.
	Value	Parameter value.

xsil::param::~param

(

void

)

Parameter destructor. brief Destructor.

---

Member Function Documentation

void xsil::param::Spew

(

Xwriter &

xout

)

const [virtual]

The parameter object is translated to XML and written to an SML output stream. brief Write parameter definition to an XML output file.

Parameters:

xout

XML output writer on which the parameter is to be written.

Implements xsil::xobj.

param* xsil::param::Clone

(

void

)

const [virtual]

An new parameter object is constructed and a pointer to the object is returned. brief Clone a parameter definition.

Returns:

Pointre to the clone.

Implements xsil::xobj.

const char* xsil::param::getObjType

(

void

)

const [virtual]

Mandatory xobj identification function.

Returns:

Pointer to the object type string.

Implements xsil::xobj.

const char* xsil::param::getUnit

(

void

)

const

The parameter nunit attribute is returned as a string. brief Get the parameter units.

Returns:

Pointer to the parameter units string.

const char* xsil::param::getValue

(

void

)

const

The parameter value is returned as a string. brief Get the parameter value.

Returns:

Pointer to the parameter value string.

void xsil::param::setUnit

(

const char *

Unit

)

The parameter units attribute is set to the argument string. No action is taken if UNit is a null pointer. brief Set the parameter units.

Parameters:

Unit

Pointer to the parameter unit string.

void xsil::param::setValue

(

const std::string &

Value

)

The parameter value string is set to the value of the argument. brief Set the parameter to a string value.

void xsil::param::setValue

(

double

Value

)

The argument is converted to a string and copied in to the parameter value string. brief Set the parameter to a numeric value.

void xsil::param::setValue

(

unsigned int

Value

)

The argument is converted to a string and copied in to the parameter value string. brief Set the parameter to an unsigned integer value.

void xsil::param::setValue

(

int

Value

)

The argument is converted to a string and copied in to the parameter value string. brief Set the parameter to an integer value.

void xsil::param::setValue

(

const char *

Value

)

The parameter value string is set to the value of the argument. brief Set the parameter to a string value.

---

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

• xsil/param.hh

---