CElement

Member Functions

CElement

   public:

 CElement();

object constructor

CElement

   public:

 CElement(const char* name);

object constructor

Parameters

Name Description

name the generic identifier for this element

Name	Description
`name`	the generic identifier for this element

addAttribute

   public:

void addAttribute(const char *attrName, const char* attrValue);

add an attribute and it's value to this object

Parameters

Name Description

attrName the name of the attribute

attrValue the value of the attribute

Name	Description
`attrName`	the name of the attribute
`attrValue`	the value of the attribute

addCDataChunk

   public:

void addCDataChunk(const char* cdata, int len);

adds character data to this element

Parameters

Name Description

cdata the actual character string

len the length of this string

Name	Description
`cdata`	the actual character string
`len`	the length of this string

addChild

   public:

void addChild(CElement *child);

adds a CElement to the child list of this object

Parameters

Name Description

child a pointer to the CElement to be added

Name	Description
`child`	a pointer to the CElement to be added

findAllChildren

   public:

void findAllChildren(const char* elemName, const char* xnamespace, std::vector &kids, bool recurse=false);

finds all children that match the generic identifier passed in the function parameters

Parameters

Name Description

elemName the generic identifier of the element to be found

xnamespace the XML namespace

recuse if true, recurse the tree pree order to find the first. otherwise just scan immediate children

kids a vector of CElement* to populate with the elements that match

Name	Description
`elemName`	the generic identifier of the element to be found
`xnamespace`	the XML namespace
`recuse`	if true, recurse the tree pree order to find the first. otherwise just scan immediate children
`kids`	a vector of CElement* to populate with the elements that match

findFirstChild

   public:

CElement *findFirstChild(const char* elemName, const char* xnamespace, bool rescurse);

a utility function that will find the first child that matches the generic identifier passed in the function parameters

Parameters

Name Description

elemName the generic identifier of the element to be found

xnamespace the XML namespace

recuse if true, recurse the tree pree order to find the first. otherwise just scan immediate children

Name	Description
`elemName`	the generic identifier of the element to be found
`xnamespace`	the XML namespace
`recuse`	if true, recurse the tree pree order to find the first. otherwise just scan immediate children

Result: a pointer to a CElement object or NULL

getAttributes

   public:

std::vector& getAttributes();

returns a vector containing all of the attributes of this elements

Result: a reference to a std::vector

getCDATAasString

   public:

void getCDATAasString(std::string& content);

concatenates all of the CDATA chunks contained by this element

Parameters

Name Description

content an output parameter where the character data is copied into

Name	Description
`content`	an output parameter where the character data is copied into

getChildren

   public:

std::vector & getChildren();

get a vector containing all of the CElement objects of which this object is the immediate parent

Result: a reference to a std::vector

getDATA

   public:

std::vector& getCDATA();

returns a vector of all of the CDATA chunks contained by this element

Result: a reference to a std::vector

getLanguage

   public:

const char* getLanguage();

getMixedContentAsXML

   public:

void getMixedContentAsXML(std::string &mixedContent);

concatenates all of the CDATA chunks and elements contained by this element and returns a syntactically valid XML document fragment

Parameters

Name Description

mixedContent the string where the document fragment is returned

Name	Description
`mixedContent`	the string where the document fragment is returned

getParent

   public:

CElement* getParent();

gets the parent of this element

Result: a pointer to a CElement or NULL if this is the root of the document

setLanguage

   public:

void setLanguage(const char* lang);

Parameters

Name Description

lang the language

Name	Description
`lang`	the language

setParent

   public:

void setParent(CElement *elem);

sets the parent of this element

Parameters

Name Description

elem a pointer to the parent element

Name	Description
`elem`	a pointer to the parent element

~CElement

   public:

virtual ~CElement();

object destructor

Member Data

m_attributes

protected:

 std::vector m_attributes;

all attributes of this element

m_cdataChunks

protected:

 std::vector m_cdataChunks;

all chunks of CDATA contained by this element

m_children

protected:

 std::vector m_children;

all direct children elements

m_lang

protected:

 std::string m_lang;

the contents of an xml:lang attribute, if any

m_parent

protected:

 CElement *m_parent;

the parent element

nMixedModel

protected:

 std::vector mMixedModel;

all CDATA chunks and elements contained by this element in the order encounted during the parse of the document