SExpressionWrapper< Data > Class Template Reference

#include <swrapper.hpp>

Inheritance diagram for SExpressionWrapper< Data >:

[legend]Collaboration diagram for SExpressionWrapper< Data >:

[legend]List of all members.

---

Detailed Description

template<class Data>
class SExpressionWrapper< Data >

An S-expression wrapper for an arbitrary compound.

The wrapper is actually a subclass of a given compound, derived from it and from SExpression as well. So, all public fields and methods available in the copmound, are available in the wrapper.

Note:

You might want to provide a copy constructor and a default constructor in the compound you wish to wrap.

The wrapped part of the object is only initialuzed by the default or the copy constructor, so think carefully is it what you want.

Definition at line 43 of file swrapper.hpp.

Public Member Functions
	SExpressionWrapper ()
	The default constructor.
	SExpressionWrapper (const Data &t)
	The data-initializing constructor.
SString	TextRepresentation () const
	Text representation of the S-expression.
const IntelibTypeId &	TermType () const
	Actual S-expression type.
bool	IsChangeable () const
	Can it be changed during the lifetime of the object?
virtual SExpression *	Clone () const
	Clone a changeable object.
virtual bool	SpecificEql (const SExpression *) const
	Are the two objects EQL (while not EQ).
Static Public Attributes
static IntelibTypeId	TypeId
	The type identifier.
Protected Member Functions
	~SExpressionWrapper ()
bool	CanDie ()
	Is it OK to delete the object now?

---

Constructor & Destructor Documentation

template<class Data> SExpressionWrapper< Data >::SExpressionWrapper (   )

The default constructor. The data part remains uninitialized, that is, the default constructor is used for it. Warning: This won't compile in case Data has no default constructor Definition at line 54 of file swrapper.hpp. References SExpressionWrapper< Data >::TypeId.

template<class Data> SExpressionWrapper< Data >::SExpressionWrapper (  const Data &  t  )

The data-initializing constructor. For Data, its copy constructor is used Definition at line 60 of file swrapper.hpp. References SExpressionWrapper< Data >::TypeId.

template<class Data> SExpressionWrapper< Data >::~SExpressionWrapper (   )  [protected]

Definition at line 68 of file swrapper.hpp.

---

Member Function Documentation

template<class Data> SString SExpressionWrapper< Data >::TextRepresentation (   )  const [virtual]

Text representation of the S-expression. Returns the text string which represents the given S-expression as for real Lisp (for example, (25 36 49)) Implements SExpression. Definition at line 64 of file swrapper.hpp.

const IntelibTypeId& SExpression::TermType (   )  const [inherited]

Actual S-expression type. Definition at line 195 of file sexpress.hpp. Referenced by SReference::DynamicCastGetPtr(), SchReference::IsEql(), LReference::IsEql(), SReference::SimpleCastGetPtr(), SchReference::TextRepresentation(), and LReference::TextRepresentation().

bool SExpression::IsChangeable (   )  const [inherited]

Can it be changed during the lifetime of the object? Definition at line 198 of file sexpress.hpp. References IntelibTypeId::IsChangeable().

virtual SExpression* SExpression::Clone (   )  const [virtual, inherited]

Clone a changeable object. The method should return the pointer created with new Note: It can (and should) return null pointer for non-changeables Warning: This method will hang your program being called for a looped data structure, including looped lists, a hash table which references a list in which it is a member, etc. If you create a changeable S-expression, you MUST make sure this method duplicates your object in such a way that nothing is shared between the old and new objects, that is, changing the new object can not in any way change the old object. Reimplemented in SExpressionBacklink, SExpressionCons, SExpressionHashTable, SExpressionRawBuffer, and SExpressionVector. Definition at line 214 of file sexpress.hpp.

virtual bool SExpression::SpecificEql (  const SExpression *   )  const [virtual, inherited]

Are the two objects EQL (while not EQ). This function is overriden by those SExpressions able to be EQL while being not EQ. Warning: It is not demanded that this function return true if it's arguments are the same SExpression (that is, they're EQ). It is only called by the EQL predicate implementation when it has been checked that the operands are not the same object. Reimplemented in SExpressionInt, SExpressionFloat, SExpressionChar, and SExpressionString. Definition at line 235 of file sexpress.hpp. Referenced by SchReference::IsEql(), and LReference::IsEql().

bool GarbageSafe::CanDie (   )  [protected, inherited]

Is it OK to delete the object now? Our children have no access to the private attribute RefCount and should never need it except when checking if the destruction is not an error. This solves the problem. Definition at line 53 of file refcount.hpp.

---

Member Data Documentation

template<class Data> IntelibTypeId SExpressionWrapper< Data >::TypeId [static]

The type identifier. Reimplemented from SExpression. Referenced by SExpressionWrapper< Data >::SExpressionWrapper().

---

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

• swrapper.hpp

---