CLAM-Development  1.4.0
Public Member Functions
CLAM::BasicXMLable Class Reference

Abstract class that defines some common implementation issues for many XMLables that contains as member variables the XML name and whether is an XML element or not. More...

#include <BasicXMLable.hxx>

List of all members.

Public Member Functions

 BasicXMLable (const char *name=0, bool isXMLElement=false)
 Constructs a BasicXMLable.
virtual ~BasicXMLable ()
const char * XMLName () const
bool IsXMLElement () const
bool IsXMLAttribute () const
bool IsXMLText () const
virtual std::string XMLContent () const =0
bool FulfilsInvariant ()
- Public Member Functions inherited from CLAM::XMLable
virtual ~XMLable ()
virtual bool XMLContent (std::istream &contentHolder)=0
- Public Member Functions inherited from CLAM::Storable
virtual ~Storable ()

Detailed Description

Abstract class that defines some common implementation issues for many XMLables that contains as member variables the XML name and whether is an XML element or not.

If you don't need those implementation issues consider using XMLable instead which defines only the interface.

Definition at line 46 of file BasicXMLable.hxx.


Constructor & Destructor Documentation

BasicXMLable::BasicXMLable ( const char *  name = 0,
bool  isXMLElement = false 
)

Constructs a BasicXMLable.

Parameters:
nameA pointer to a 0 terminated string containing the xml name (for elements and attributes) or 0 (the default) if the element is neither an element nor an attribute (
See also:
BasicXMLable for important details about memory managing). Because no internal copy of the string is done, the 0 terminated string pointed by name must exist during the BasicXMLable life as is directly used.
Parameters:
isXMLElementTells whether the object is an element or an attribute when the name is defined.

Definition at line 31 of file BasicXMLable.cxx.

References CLAM_ASSERT, CLAM_BEGIN_CHECK, and CLAM_END_CHECK.

BasicXMLable::~BasicXMLable ( )
virtual

Definition at line 27 of file BasicXMLable.cxx.


Member Function Documentation

bool BasicXMLable::FulfilsInvariant ( )
bool CLAM::BasicXMLable::IsXMLAttribute ( ) const
inlinevirtual

Implements CLAM::XMLable.

Definition at line 82 of file BasicXMLable.hxx.

bool CLAM::BasicXMLable::IsXMLElement ( ) const
inlinevirtual

Implements CLAM::XMLable.

Definition at line 77 of file BasicXMLable.hxx.

bool CLAM::BasicXMLable::IsXMLText ( ) const
inlinevirtual

Implements CLAM::XMLable.

Definition at line 86 of file BasicXMLable.hxx.

virtual std::string CLAM::BasicXMLable::XMLContent ( ) const
pure virtual
const char* CLAM::BasicXMLable::XMLName ( ) const
inlinevirtual

Implements CLAM::XMLable.

Definition at line 72 of file BasicXMLable.hxx.


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