xsil::XSIL Class Reference
[Xsil document preparation]

#include <xsil.hh>

Inheritance diagram for xsil::XSIL:

List of all members.

Public Member Functions
	XSIL (void)
	XSIL (const char *Name, const char *Type=0)
	XSIL (const XSIL &x)
virtual	~XSIL (void)
virtual XSIL *	Clone (void) const
void	Spew (Xwriter &ostr) const
virtual const xobj *	find (const std::string &nm, const std::string &ty) const
virtual xobj *	find (const std::string &nm, const std::string &ty)
xobj *	addObject (const xobj &x)
xobj *	addObject (xobj *x)
virtual XSIL *	addXSIL (const char *Name, const char *Type=0)
array *	addArray (const char *Name, const char *Type=0, const char *Unit=0)
comment *	addComment (const char *Text=0)
param *	addParam (const char *Name, const char *Type=0, const char *Unit=0, const char *Value=0)
param *	addParam (const char *Name, const char *Unit, double Value)
param *	addParam (const char *Name, const char *Unit, int Value)
table *	addTable (const char *Name, const char *Type=0)
time *	addTime (const char *Name, const char *Type=0, const char *Value=0)
time *	addTime (const char *Name, const Time &t)
void	erase (const xobj *x)
virtual const char *	getObjType (void) const

---

Detailed Description

XSIL class is the light-weight container for encoded xsil objects. brief Xsil document container.

Author:

John Zweizig

Version:

1.0; Last modified March 6, 2008

---

Constructor & Destructor Documentation

xsil::XSIL::XSIL

(

void

)

XSil default constructor. brief default constructor.

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

XSIL named structure constructor. brief Named structure constructor.

Parameters:

	Name	Pointer to structure name string.
	Type	Pointer to structure type string.

xsil::XSIL::XSIL

(

const XSIL &

x

)

XSIL structure copy constructor. brief Copy constructor.

Parameters:

x

Structure definition to be copied.

virtual xsil::XSIL::~XSIL

(

void

)

[virtual]

Destructor. brief Destructor.

---

Member Function Documentation

virtual XSIL* xsil::XSIL::Clone

(

void

)

const [virtual]

Clone a structure. brief Clone a structure.

Returns:

opinter to a new object.

Implements xsil::xobj.

Reimplemented in xsil::ligolw.

void xsil::XSIL::Spew

(

Xwriter &

ostr

)

const [virtual]

Write XML structure to the specified writer. brief Write XML.

Parameters:

ostr

XML output stream object.

Implements xsil::xobj.

virtual const xobj* xsil::XSIL::find	(	const std::string &	nm,
		const std::string &	ty
	)			const [virtual]

Find an object with the specified name and object type inside the container. The first object of the specified type with the requested name is returned. If the type or name are specified as an empty string, any type or name is considered to match. Find returns a null if the specified name isn't found. brief find an object.

Parameters:

	nm	Name of requested object.
	ty	Type of requested object.

Returns:

Constant pointer to the requested object or NULL.

Reimplemented from xsil::xobj.

virtual xobj* xsil::XSIL::find	(	const std::string &	nm,
		const std::string &	ty
	)			[virtual]

Find an object with the specified name and object type inside the container. The first object of the specified type with the requested name is returned. If the type or name are specified as an empty string, any type or name is considered to match. Find returns a null if the specified name isn't found. brief find an object.

Parameters:

	nm	Name of requested object.
	ty	Type of requested object.

Returns:

Pointer to the requested object or NULL.

Reimplemented from xsil::xobj.

xobj* xsil::XSIL::addObject

(

const xobj &

x

)

Clone a generic object and add the clone to the object list. brief Add an object.

Parameters:

x

object to be cloned into the xsil structure.

Returns:

Pointer to the added structure definition.

xobj* xsil::XSIL::addObject

(

xobj *

x

)

Add an existing generic object to the object list. brief Add an object.

Parameters:

x

object to be added to the xsil structure.

Returns:

Pointer to the added structure definition.

virtual XSIL* xsil::XSIL::addXSIL	(	const char *	Name,
		const char *	Type = 0
	)			[virtual]

Add a named XSIL substructure. brief Add an XSIL substructure.

Parameters:

	Name	Pointer to structure name string.
	Type	Pointer to structure type string.

Returns:

Pointer to the added structure definition.

Reimplemented in xsil::ligolw.

array* xsil::XSIL::addArray	(	const char *	Name,
		const char *	Type = 0,
		const char *	Unit = 0
	)

Add a named XSIL array to the XSil structure. brief Add an array.

Parameters:

	Name	Pointer to structure name string.
	Type	Pointer to structure type string.
	Unit	Pointer to structure units string.

Returns:

Pointer to the added array definition.

comment* xsil::XSIL::addComment

(

const char *

Text = 0

)

Add a comment to the XSil structure. brief Add a comment.

Parameters:

Text

Pointer to the comment text string.

Returns:

Pointer to the added comment definition.

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

Add a parameter to the XSil structure. brief Add a parameter.

Parameters:

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

Returns:

Pointer to the added parameter definition.

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

Add a double float parameter to the XSil structure. brief Add a double float parameter.

Parameters:

	Name	Pointer to parameter name string.
	Unit	Pointer to parameter units string.
	Value	Double float parameter value.

Returns:

Pointer to the added parameter definition.

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

Add an integer parameter to the XSil structure. brief Add an integer parameter.

Parameters:

	Name	Pointer to parameter name string.
	Unit	Pointer to parameter units string.
	Value	Integer parameter value.

Returns:

Pointer to the added parameter definition.

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

Add a table to the XSil structure. brief Add a table.

Parameters:

	Name	Pointer to the table name string.
	Type	Pointer to the table type string.

Returns:

Pointer to the added table definition.

time* xsil::XSIL::addTime	(	const char *	Name,
		const char *	Type = 0,
		const char *	Value = 0
	)

Add a time to the XSil structure. brief Add a time.

Parameters:

	Name	Pointer to the time name string.
	Type	Pointer to the time type string.
	Value	Pointer to the time value string.

Returns:

Pointer to the added time parameter definition.

time* xsil::XSIL::addTime	(	const char *	Name,
		const Time &	t
	)

Add a time to the XSil structure. brief Add a time.

Parameters:

	Name	Pointer to the time name string.
	t	Time value;

Returns:

Pointer to the added time parameter definition.

void xsil::XSIL::erase

(

const xobj *

x

)

Remove an object from the xsil structure. brief Remove an object.

Parameters:

x

Pointer to the object to be removed from the xsil structure.

virtual const char* xsil::XSIL::getObjType

(

void

)

const [virtual]

Return the object type. brief Object type name.

Returns:

Pointer to the object name string.

Implements xsil::xobj.

Reimplemented in xsil::ligolw.

---

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

• xsil/xsil.hh

---