xsil::xobj Class Reference
[Xsil document preparation]

#include <xobj.hh>

Inheritance diagram for xsil::xobj:

List of all members.

Public Member Functions
	xobj (void)
	xobj (const char *Name, const char *Type=0)
virtual	~xobj (void)
virtual void	Spew (xsil::Xwriter &ostr) const =0
virtual const char *	getObjType (void) const =0
virtual xobj *	Clone (void) const =0
virtual const xobj *	find (const std::string &name) const
	Find a named object.
virtual xobj *	find (const std::string &name)
	Find a named object.
virtual const xobj *	find (const std::string &nm, const std::string &ty) const
virtual xobj *	find (const std::string &nm, const std::string &ty)
const char *	getName (void) const
const char *	getType (void) const
const std::string &	refName (void) const
const std::string &	refType (void) const
void	setName (const char *Name)
void	setType (const char *Type)

---

Detailed Description

The xobj class contains the name and type fields common to (almost) all of the XSil data objects. It also provides a standard interface for puting object of different types into lists. brief XSIL object base class

Author:

J. Zweizig

Version:

1.1; Modified December 13, 1999

---

Constructor & Destructor Documentation

xsil::xobj::xobj

(

void

)

Default (null) constructor. brief Null constructor.

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

Data constructor brief Data constructor

Parameters:

	Name	Pointer to the object name string
	Type	Pointer to the object type string

virtual xsil::xobj::~xobj

(

void

)

[inline, virtual]

Object destructor. brief Object destructor.

---

Member Function Documentation

virtual void xsil::xobj::Spew

(

xsil::Xwriter &

ostr

)

const [pure virtual]

Write the Object and any embedded object to an XML file. brief Write the object to an XML file

Parameters:

ostr

XML output file descriptor.

Implemented in xsil::array, xsil::column, xsil::comment, xsil::dim, xsil::param, xsil::Stream, xsil::table, xsil::time, and xsil::XSIL.

virtual const char* xsil::xobj::getObjType

(

void

)

const [pure virtual]

Get the object type brief Get the object type

Returns:

pointer to the object type string.

Implemented in xsil::array, xsil::column, xsil::comment, xsil::dim, xsil::ligolw, xsil::param, xsil::Stream, xsil::table, xsil::time, and xsil::XSIL.

virtual xobj* xsil::xobj::Clone

(

void

)

const [pure virtual]

Create an identical copy(clone) of the current object. brief Clone an object

Returns:

Pointer to the newly created clone

Implemented in xsil::array, xsil::column, xsil::comment, xsil::dim, xsil::ligolw, xsil::param, xsil::Stream, xsil::table, xsil::time, and xsil::XSIL.

virtual const xobj* xsil::xobj::find

(

const std::string &

name

)

const [virtual]

Find a named object.

Find an object with the specified name inside a container. Find returns a null pointer if the object is not a container or if the specified name isn't found.

Parameters:

name

Name attribute of object to be found.

Returns:

Constant pointer to the named xsil object or null.

virtual xobj* xsil::xobj::find

(

const std::string &

name

)

[virtual]

Find a named object.

Find an object with the specified name inside a container. Find returns a null pointer if the object is not a container or if the specified name isn't found.

Parameters:

name

Name attribute of object to be found.

Returns:

Pointer to the named xsil object or null.

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

Find an object with the specified name and type inside a container. The first object in the container matching the specified type and 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 pointer if the object is not a container or if the specified name isn't found. The default xObj implementation returns a Null for all names. This should be overridden by any container object. 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 in xsil::XSIL.

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

Find an object with the specified name and type inside a container. The first object in the container matching the specified type and 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 pointer if the object is not a container or if the specified name isn't found. The default xObj implementation returns a Null for all names. This should be overridden by any container object. brief find an object.

Parameters:

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

Returns:

Pointer to the requested object or NULL.

Reimplemented in xsil::XSIL.

const char* xsil::xobj::getName

(

void

)

const

Get the object name brief Get the object name

Returns:

Pointer to the object type name

const char* xsil::xobj::getType

(

void

)

const

Get the object type field brief Get the object type field

Returns:

Pointer to the object type string.

const std::string & xsil::xobj::refName

(

void

)

const [inline]

Get the object name brief Get the object name

Returns:

Reference to the object name string.

const std::string & xsil::xobj::refType

(

void

)

const [inline]

Get the object type field brief Get the object type field

Returns:

Reference to the object type string.

void xsil::xobj::setName

(

const char *

Name

)

Set the object name brief Set the oobject name

Parameters:

Name

Pointer to the object type name

void xsil::xobj::setType

(

const char *

Type

)

Set the object type field. brief Set the object type

Parameters:

Type

Pointer to the object type string.

---

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

• xsil/xobj.hh

---