ticpp::Element Class Reference

Wrapper around TiXmlElement. More...

#include <ticpp.h>

Inheritance diagram for ticpp::Element:

Collaboration diagram for ticpp::Element:

Public Member Functions
	Element ()
	Default Constructor. More...
	Element (const std::string &value)
	Default Constructor. More...
	Element (const char *value)
	Default Constructor. More...
	Element (TiXmlElement *element)
	Constructor. More...
template<class T >
	Element (const std::string &value, const T &text)
	Constructor that allows you to set the element text. More...
Attribute *	FirstAttribute (bool throwIfNoAttributes=true) const
	Access the first attribute in this element. More...
Attribute *	LastAttribute (bool throwIfNoAttributes=true) const
	Access the last attribute in this element. More...
void	IterateFirst (const std::string &, Attribute **first) const
template<class T >
void	SetAttribute (const std::string &name, const T &value)
	Sets an attribute of name to a given value. More...
std::string	GetText (bool throwIfNotFound=true) const
	Gets the text of an Element. More...
std::string	GetTextOrDefault (const std::string &defaultValue) const
	Gets the text of an Element, if it doesn't exist it will return the defaultValue. More...
template<class T , class DefaultT >
void	GetTextOrDefault (T *value, const DefaultT &defaultValue) const
	Gets the text value of an Element, if it doesn't exist it will return the defaultValue. More...
template<class T >
void	GetText (T *value, bool throwIfNotFound=true) const
	Gets the text of an Element. More...
template<class T >
void	SetText (const T &value)
	Convenience function to set the text of an element. More...
template<class T , class DefaulT >
void	GetAttributeOrDefault (const std::string &name, T *value, const DefaulT &defaultValue) const
	Gets an attribute of name from an element, if it doesn't exist it will return the defaultValue. More...
std::string	GetAttributeOrDefault (const std::string &name, const std::string &defaultValue) const
	Gets an attribute of name from an element, if it doesn't exist it will return the defaultValue. More...
template<class T >
T	GetAttribute (const std::string &name, bool throwIfNotFound=true) const
	Returns an attribute of name from an element. More...
template<class T >
void	GetAttribute (const std::string &name, T *value, bool throwIfNotFound=true) const
	Gets an attribute of name from an element. More...
std::string	GetAttribute (const std::string &name) const
	Gets an attribute of name from an element. More...
bool	HasAttribute (const std::string &name) const
	Returns true, if attribute exists. More...
void	RemoveAttribute (const std::string &name)
	Removes attribute from element. More...
template<class T >
void	GetValue (T *value) const
	Get the value of this node Uses Base::FromString to convert TiXmlNode::ValueStr from a std::string, and puts it in the passed pointer. More...
std::string	Value () const
	Get the value of this node. More...
template<class T >
void	SetValue (const T &value)
	Set the value of this node. More...
void	Clear ()
	Clear all Nodes below this. More...
Node *	Parent (bool throwIfNoParent=true) const
	The Parent of this Node. More...
Node *	FirstChild (bool throwIfNoChildren=true) const
	The first child of this node. More...
Node *	FirstChild (const char *value, bool throwIfNoChildren=true) const
Node *	FirstChild (const std::string &value, bool throwIfNoChildren=true) const
	The first child of this node with the matching value. More...
Node *	LastChild (bool throwIfNoChildren=true) const
	The last child of this node. More...
Node *	LastChild (const char *value, bool throwIfNoChildren=true) const
Node *	LastChild (const std::string &value, bool throwIfNoChildren=true) const
	The last child of this node with the matching value. More...
Node *	IterateChildren (Node *previous) const
	An alternate way to walk the children of a node. More...
Node *	IterateChildren (const std::string &value, Node *previous) const
	This flavor of IterateChildren searches for children with a particular value. More...
Node *	InsertEndChild (Node &addThis)
	Adds a child past the LastChild. More...
Node *	LinkEndChild (Node *childNode)
	Adds a child past the LastChild. More...
Node *	InsertBeforeChild (Node *beforeThis, Node &addThis)
	Adds a child before the specified child. More...
Node *	InsertAfterChild (Node *afterThis, Node &addThis)
	Adds a child after the specified child. More...
Node *	ReplaceChild (Node *replaceThis, Node &withThis)
	Replace a child of this node. More...
void	RemoveChild (Node *removeThis)
	Delete a child of this node. More...
Node *	PreviousSibling (bool throwIfNoSiblings=true) const
	Navigate to a sibling node. More...
Node *	PreviousSibling (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling node with the given value. More...
Node *	PreviousSibling (const char *value, bool throwIfNoSiblings=true) const
Node *	NextSibling (bool throwIfNoSiblings=true) const
	Navigate to a sibling node. More...
Node *	NextSibling (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling node with the given value. More...
Node *	NextSibling (const char *value, bool throwIfNoSiblings=true) const
template<class T >
void	IterateFirst (const std::string &value, T **first) const
template<class T >
void	IterateNext (const std::string &value, T **next) const
template<class T >
void	IteratePrevious (const std::string &value, T **previous) const
Element *	NextSiblingElement (bool throwIfNoSiblings=true) const
	Navigate to a sibling element. More...
Element *	NextSiblingElement (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling element with the given value. More...
Element *	NextSiblingElement (const char *value, bool throwIfNoSiblings=true) const
Element *	FirstChildElement (bool throwIfNoChildren=true) const
	The first child element of this node. More...
Element *	FirstChildElement (const char *value, bool throwIfNoChildren=true) const
Element *	FirstChildElement (const std::string &value, bool throwIfNoChildren=true) const
	The first child element of this node with the matching value. More...
int	Type () const
	Query the type (as TiXmlNode::NodeType ) of this node. More...
Document *	GetDocument (bool throwIfNoDocument=true) const
	Return a pointer to the Document this node lives in. More...
bool	NoChildren () const
	Check if this node has no children. More...
template<class T >
T *	To () const
	Pointer conversion ( NOT OBJECT CONVERSION ) - replaces TiXmlNode::ToElement, TiXmlNode::ToDocument, TiXmlNode::ToComment, etc. More...
Document *	ToDocument () const
	Pointer conversion - replaces TiXmlNode::ToDocument. More...
Element *	ToElement () const
	Pointer conversion - replaces TiXmlNode::ToElement. More...
Comment *	ToComment () const
	Pointer conversion - replaces TiXmlNode::ToComment. More...
Text *	ToText () const
	Pointer conversion - replaces TiXmlNode::ToText. More...
Declaration *	ToDeclaration () const
	Pointer conversion - replaces TiXmlNode::ToDeclaration. More...
StylesheetReference *	ToStylesheetReference () const
	Pointer conversion - replaces TiXmlNode::ToStylesheetReference. More...
std::unique_ptr< Node >	Clone () const
	Create an exact duplicate of this node and return it. More...
bool	Accept (TiXmlVisitor *visitor) const
	Accept a hierchical visit the nodes in the TinyXML DOM. More...
template<class T >
std::string	ToString (const T &value) const
	Converts any class with a proper overload of the << opertor to a std::string. More...
std::string	ToString (const std::string &value) const
template<class T >
void	FromString (const std::string &temp, T *out) const
	Converts a std::string to any class with a proper overload of the >> opertor. More...
void	FromString (const std::string &temp, std::string *out) const
	Specialization for std::string. More...
int	Row () const
	Return the position, in the original source file, of this node or attribute. More...
int	Column () const
	Return the position, in the original source file, of this node or attribute. More...
bool	operator== (const Base &rhs) const
	Compare internal TiXml pointers to determine is both are wrappers around the same node. More...
bool	operator!= (const Base &rhs) const
	Compare internal TiXml pointers to determine is both are wrappers around the same node. More...
std::string	BuildDetailedErrorString () const
	Builds detailed error string using TiXmlDocument::Error() and others. More...

Protected Attributes
TiXmlElement *	m_tiXmlPointer
	Internal pointer to the TiXml Class which is being wrapped. More...
TiCppRCImp *	m_impRC
	Holds status of internal TiXmlPointer - use this to determine if object has been deleted already. More...

Protected Member Functions
TiXmlNode *	GetTiXmlPointer () const
void	SetTiXmlPointer (TiXmlElement *newPointer)
TiXmlBase *	GetBasePointer () const
Node *	NodeFactory (TiXmlNode *tiXmlNode, bool throwIfNull=true, bool rememberSpawnedWrapper=true) const
void	SetImpRC (TiXmlBase *nodeBase)
void	ValidatePointer () const

Detailed Description

Wrapper around TiXmlElement.

Definition at line 1493 of file ticpp.h.

Constructor & Destructor Documentation

Element() [1/5]

Element::Element

(

)

Default Constructor.

Definition at line 747 of file ticpp.cpp.

References Element().

Referenced by Element().

    : NodeImp< TiXmlElement >(new TiXmlElement(
        "DefaultValueCausedByCreatingAnElementWithNoParameters")) {
  m_impRC->InitRef();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Element() [2/5]

Element::Element

(

const std::string &

value

)

Default Constructor.

Initializes all the variables.

Parameters

value

The value of the element.

Definition at line 753 of file ticpp.cpp.

References Element().

Referenced by Element().

    : NodeImp< TiXmlElement >(new TiXmlElement(value)) {
  m_impRC->InitRef();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Element() [3/5]

Element::Element

(

const char *

value

)

Default Constructor.

Initializes all the variables.

Parameters

value

The value of the element.

Definition at line 758 of file ticpp.cpp.

References Element().

Referenced by Element().

    : NodeImp< TiXmlElement >(new TiXmlElement(value)) {
  m_impRC->InitRef();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Element() [4/5]

Element::Element

(

TiXmlElement *

element

)

Constructor.

Definition at line 763 of file ticpp.cpp.

References Element().

Referenced by Element(), ticpp::Node::FirstChildElement(), ticpp::Node::NextSiblingElement(), ticpp::Node::ToElement(), ticpp::Visitor::VisitEnter(), and ticpp::Visitor::VisitExit().

    : NodeImp< TiXmlElement >(element) {}

Here is the call graph for this function:

Here is the caller graph for this function:

Element() [5/5]

template<class T >

ticpp::Element::Element ( const std::string &  value, const T &  text  )

inline

Constructor that allows you to set the element text.

Parameters

value	The value of the element.
text	The text to set.

Definition at line 1523 of file ticpp.h.

References Element().

Referenced by Element().

        : NodeImp< TiXmlElement >(new TiXmlElement(value)) {
      m_impRC->InitRef();
      SetText(text);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

Accept()

bool Node::Accept ( TiXmlVisitor *  visitor ) const

inherited

Accept a hierchical visit the nodes in the TinyXML DOM.

Returns

The boolean returned by the visitor.

Definition at line 650 of file ticpp.cpp.

References TiXmlNode::Accept(), and ticpp::Node::GetTiXmlPointer().

                                             {
  return GetTiXmlPointer()->Accept(visitor);
}

Here is the call graph for this function:

BuildDetailedErrorString()

std::string ticpp::Base::BuildDetailedErrorString ( ) const

inlineinherited

Builds detailed error string using TiXmlDocument::Error() and others.

Definition at line 238 of file ticpp.h.

References TiXmlDocument::Error(), and ticpp::Base::GetBasePointer().

                                               {
      std::ostringstream full_message;
#ifndef TICPP_NO_RTTI
      TiXmlNode* node = dynamic_cast< TiXmlNode* >(GetBasePointer());

      if (node != 0) {
        TiXmlDocument* doc = node->GetDocument();

        if (doc != 0) {
          if (doc->Error()) {
            full_message << "\nDescription: " << doc->ErrorDesc() << "\nFile: "
                         << (strlen(doc->Value()) > 0 ? doc->Value()
                                                      : "<unnamed-file>")
                         << "\nLine: " << doc->ErrorRow()
                         << "\nColumn: " << doc->ErrorCol();
          }
        }
      }

#endif
      return full_message.str();
    }

Here is the call graph for this function:

Clear()

void Node::Clear ( )

inherited

Clear all Nodes below this.

Simple wrapper for TiXmlNode::Clear.

Definition at line 232 of file ticpp.cpp.

References TiXmlNode::Clear(), and ticpp::Node::GetTiXmlPointer().

{ GetTiXmlPointer()->Clear(); }

Here is the call graph for this function:

Clone()

std::unique_ptr< Node > Node::Clone ( ) const

inherited

Create an exact duplicate of this node and return it.

Note

Using auto_ptr to manage the memory declared on the heap by TiXmlNode::Clone.

// Now using clone
ticpp::Document doc( "C:\\Test.xml" );
ticpp::Node* sectionToClone;
sectionToClone = doc.FirstChild( "settings" );
std::auto_ptr< ticpp::Node > clonedNode = sectionToClone->Clone();
// Now you can use the clone.
ticpp::Node* node2 = clonedNode->FirstChildElement()->FirstChild();
...
// After the variable clonedNode goes out of scope it will automatically be
cleaned up.

Returns

Pointer the duplicate node.

Definition at line 635 of file ticpp.cpp.

References TiXmlNode::Clone(), and ticpp::Node::GetTiXmlPointer().

                                        {
  TiXmlNode* node = GetTiXmlPointer()->Clone();

  if (0 == node) {
    TICPPTHROW("Node could not be cloned");
  }

  std::unique_ptr< Node > temp(NodeFactory(node, false, false));

  // Take ownership of the memory from TiXml
  temp->m_impRC->InitRef();

  return temp;
}

Here is the call graph for this function:

Column()

int ticpp::Base::Column ( ) const

inlineinherited

Return the position, in the original source file, of this node or attribute.

Wrapper around TiXmlBase::Row()

Definition at line 215 of file ticpp.h.

References TiXmlBase::Column(), and ticpp::Base::GetBasePointer().

{ return GetBasePointer()->Column(); }

Here is the call graph for this function:

FirstAttribute()

Attribute * Element::FirstAttribute

(

bool

throwIfNoAttributes = true

)

const

Access the first attribute in this element.

Parameters

throwIfNoAttributes

[DEF] If true, throws when there are no attributes

Returns

The first attribute, nullptr if there are none and throwIfNoAttributes is true

Definition at line 766 of file ticpp.cpp.

References ticpp::Attribute::Attribute().

Referenced by IterateFirst().

                                                                 {
  ValidatePointer();
  TiXmlAttribute* attribute = m_tiXmlPointer->FirstAttribute();

  if ((0 == attribute) && throwIfNoAttributes) {
    TICPPTHROW("This Element (" << Value() << ") has no attributes")
  }

  if (0 == attribute) {
    if (throwIfNoAttributes) {
      TICPPTHROW("Element (" << Value() << ") has no attributes")
    } else {
      return 0;
    }
  }

  Attribute* temp = new Attribute(attribute);
  attribute->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FirstChild() [1/3]

Node * Node::FirstChild ( bool  throwIfNoChildren = true ) const

inherited

The first child of this node.

Parameters

throwIfNoChildren

[DEF] If true, will throw an exception if there are no children.

Returns

Pointer to child, Null if no children and 'throwIfNoChildren' is false.

Exceptions

Exception

When throwIfNoChildren is true, and TiXmlNode::FirstChild returns Null.

See also

TiXmlNode::FirstChild

Definition at line 244 of file ticpp.cpp.

References ticpp::Node::FirstChild().

                                                   {
  return FirstChild("", throwIfNoChildren);
}

Here is the call graph for this function:

FirstChild() [2/3]

Node * Node::FirstChild ( const char *  value, bool  throwIfNoChildren = true  ) const

inherited

Definition at line 252 of file ticpp.cpp.

References TiXmlNode::FirstChild(), ticpp::Node::GetTiXmlPointer(), and ticpp::Node::NodeFactory().

Referenced by ticpp::Node::FirstChild().

                                                                      {
  TiXmlNode* childNode;

  if (0 == strlen(value)) {
    childNode = GetTiXmlPointer()->FirstChild();
  } else {
    childNode = GetTiXmlPointer()->FirstChild(value);
  }

  if ((0 == childNode) && throwIfNoChildren) {
    TICPPTHROW("Child with the value of \"" << value << "\" not found");
  }

  return NodeFactory(childNode, false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

FirstChild() [3/3]

Node * Node::FirstChild ( const std::string &  value, bool  throwIfNoChildren = true  ) const

inherited

The first child of this node with the matching value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	Value to match.
throwIfNoChildren	[DEF] If true, will throw an exception if there are no children.

See also

FirstChild( const char* value, bool throwIfNoChildren = true )

Definition at line 248 of file ticpp.cpp.

                                                                           {
  return FirstChild(value.c_str(), throwIfNoChildren);
}

FirstChildElement() [1/3]

Element * Node::FirstChildElement ( bool  throwIfNoChildren = true ) const

inherited

The first child element of this node.

Parameters

throwIfNoChildren

[DEF] If true, will throw an exception if there are no element children.

Returns

Pointer to child, Null if no element children and 'throwIfNoChildren' is false.

Exceptions

Exception

When throwIfNoChildren is true, and TiXmlNode::FirstChildElement returns Null.

See also

TiXmlNode::FirstChildElement

Definition at line 501 of file ticpp.cpp.

References ticpp::Node::FirstChildElement().

                                                             {
  return FirstChildElement("", throwIfNoChildren);
}

Here is the call graph for this function:

FirstChildElement() [2/3]

Element * Node::FirstChildElement ( const char *  value, bool  throwIfNoChildren = true  ) const

inherited

Definition at line 510 of file ticpp.cpp.

References Element(), TiXmlNode::FirstChildElement(), and ticpp::Node::GetTiXmlPointer().

Referenced by ticpp::Node::FirstChildElement().

                                                                                {
  TiXmlElement* element;

  if (0 == strlen(value)) {
    element = GetTiXmlPointer()->FirstChildElement();
  } else {
    element = GetTiXmlPointer()->FirstChildElement(value);
  }

  if (0 == element) {
    if (throwIfNoChildren) {
      TICPPTHROW("Element (" << Value()
                             << ") does NOT contain a child with the value of '"
                             << value
                             << "'")
    } else {
      return 0;
    }
  }

  Element* temp = new Element(element);
  element->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FirstChildElement() [3/3]

Element * Node::FirstChildElement ( const std::string &  value, bool  throwIfNoChildren = true  ) const

inherited

The first child element of this node with the matching value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	Value to match.
throwIfNoChildren	[DEF] If true, will throw an exception if there are no element children.

See also

FirstChildElement( const char* value, bool throwIfNoChildren = true )

Definition at line 505 of file ticpp.cpp.

                                                                             {
  return FirstChildElement(value.c_str(), throwIfNoChildren);
}

FromString() [1/2]

template<class T >

void ticpp::Base::FromString ( const std::string &  temp, T *  out  ) const

inlineinherited

Converts a std::string to any class with a proper overload of the >> opertor.

Parameters

temp	The string to be converted
out	[OUT] The container for the returned value

Exceptions

Exception

When temp cannot be converted to the target type

Definition at line 189 of file ticpp.h.

                                                         {
      std::istringstream val(temp);
      val >> *out;

      if (val.fail()) {
        TICPPTHROW("Could not convert \"" << temp << "\" to target type");
      }
    }

FromString() [2/2]

void ticpp::Base::FromString ( const std::string &  temp, std::string *  out  ) const

inlineinherited

Specialization for std::string.

Definition at line 201 of file ticpp.h.

                                                                 {
      *out = temp;
    }

GetAttribute() [1/3]

template<class T >

T ticpp::Element::GetAttribute ( const std::string &  name, bool  throwIfNotFound = true  ) const

inline

Returns an attribute of name from an element.

Uses FromString to convert the string to the type of choice.

Parameters

name	The name of the attribute you are querying.
throwIfNotFound	[DEF] If true, will throw an exception if the attribute doesn't exist

Exceptions

Exception

When the attribute doesn't exist and throwIfNotFound is true

See also

GetAttributeOrDefault

Definition at line 1789 of file ticpp.h.

                                                                             {
      // Get the attribute's value as a std::string
      std::string temp;
      T           value;

      if (!GetAttributeImp(name, &temp)) {
        if (throwIfNotFound) {
          const std::string error(std::string("Attribute '") + name +
                                  std::string("' does not exist"));
          TICPPTHROW(error);
        }
      } else {
        // Stream the value from the string to T
        FromString(temp, &value);
      }

      return value;
    }

GetAttribute() [2/3]

template<class T >

void ticpp::Element::GetAttribute ( const std::string &  name, T *  value, bool  throwIfNotFound = true  ) const

inline

Gets an attribute of name from an element.

Uses FromString to convert the string to the type of choice.

Parameters

name	The name of the attribute you are querying.
value	[OUT] The container for the returned value
throwIfNotFound	[DEF] If true, will throw an exception if the attribute doesn't exist

Exceptions

Exception

When the attribute doesn't exist and throwIfNotFound is true

See also

GetAttributeOrDefault

Definition at line 1823 of file ticpp.h.

                                                                       {
      // Get the attribute's value as a std::string
      std::string temp;

      if (!GetAttributeImp(name, &temp)) {
        if (throwIfNotFound) {
          const std::string error(std::string("Attribute '") + name +
                                  std::string("' does not exist"));
          TICPPTHROW(error);
        } else {
          return;
        }
      }

      // Stream the value from the string to T
      FromString(temp, value);
    }

GetAttribute() [3/3]

std::string Element::GetAttribute

(

const std::string &

name

)

const

Gets an attribute of name from an element.

Returns an empty string if the attribute does not exist.

Parameters

name	The name of the attribute you are querying.

Returns

The value of the attribute, or an empty string if it does not exist.

See also

GetAttributeOrDefault

Definition at line 821 of file ticpp.cpp.

                                                           {
  return GetAttributeOrDefault(name, std::string());
}

GetAttributeImp()

bool Element::GetAttributeImp ( const std::string &  name, std::string *  value  ) const

private

Definition at line 835 of file ticpp.cpp.

                                                                           {
  ValidatePointer();

  // Get value from TinyXML, if the attribute exists
  const char* retVal = m_tiXmlPointer->Attribute(name.c_str());

  // TinyXML returns nullptr if the attribute doesn't exist
  if (0 == retVal) {
    return false;
  } else {
    *value = retVal;
    return true;
  }
}

GetAttributeOrDefault() [1/2]

template<class T , class DefaulT >

void ticpp::Element::GetAttributeOrDefault ( const std::string &  name, T *  value, const DefaulT &  defaultValue  ) const

inline

Gets an attribute of name from an element, if it doesn't exist it will return the defaultValue.

Uses FromString to convert the string to the type of choice.

Parameters

name	The name of the attribute you are querying.
value	[OUT] The container for the returned value.
defaultValue	What to put in value if there is no attribute in this element.

Exceptions

Exception

See also

GetAttribute

Definition at line 1746 of file ticpp.h.

                                                                      {
      // Get the attribute's value as a std::string
      std::string temp;

      if (!GetAttributeImp(name, &temp)) {
        // The attribute does not exist - set value to the default
        *value = defaultValue;
        return;
      }

      // Stream the value from the string to T
      FromString(temp, value);
    }

GetAttributeOrDefault() [2/2]

std::string Element::GetAttributeOrDefault	(	const std::string &	name,
		const std::string &	defaultValue
	)		const

Gets an attribute of name from an element, if it doesn't exist it will return the defaultValue.

Parameters

name	The name of the attribute you are querying.
defaultValue	What to put in value if there is no attribute in this element.

See also

GetAttribute

Definition at line 810 of file ticpp.cpp.

                                                                                {
  std::string value;

  if (!GetAttributeImp(name, &value)) {
    return defaultValue;
  }

  return value;
}

GetBasePointer()

TiXmlBase* ticpp::Node::GetBasePointer ( ) const

inlineprotectedvirtualinherited

Implements ticpp::Base.

Definition at line 1073 of file ticpp.h.

{ return GetTiXmlPointer(); }

GetDocument()

Document * Node::GetDocument ( bool  throwIfNoDocument = true ) const

inherited

Return a pointer to the Document this node lives in.

Parameters

throwIfNoDocument

[DEF] If true, will throw an exception if this node is not linked under a Document.

Returns

A pointer to the Document this node lives in, nullptr if not linked under a Document, and 'throwIfNoDocument' is false.

Exceptions

Exception

When this node is not linked under a Document and 'throwIfNoDocument' is true.

Definition at line 538 of file ticpp.cpp.

References ticpp::Document::Document().

                                                        {
  TiXmlDocument* doc = GetTiXmlPointer()->GetDocument();

  if (0 == doc) {
    if (throwIfNoDocument) {
      TICPPTHROW("This node (" << Value() << ") is not linked under a document")
    } else {
      return 0;
    }
  }

  Document* temp = new Document(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

GetText() [1/2]

std::string ticpp::Element::GetText ( bool  throwIfNotFound = true ) const

inline

Gets the text of an Element.

Parameters

throwIfNotFound

[DEF] If true, will throw an exception if there is no text in this element

Note

This only works if the Text is the FirstChild node

Exceptions

Exception

When there is no text and throwIfNotFound is true

See also

GetText( T* value, bool throwIfNotFound = false )

GetTextOrDefault

GetTextOrDefault( T* value, const DefaultT& defaultValue )

TiXmlElement::GetText

Definition at line 1600 of file ticpp.h.

                                                         {
      // Get the element's text value as a std::string
      std::string temp;

      if (!GetTextImp(&temp)) {
        if (throwIfNotFound) {
          TICPPTHROW("Text does not exists in the current element");
        }
      }

      return temp;
    }

GetText() [2/2]

template<class T >

void ticpp::Element::GetText ( T *  value, bool  throwIfNotFound = true  ) const

inline

Gets the text of an Element.

Uses FromString to convert the string to the type of choice.

Parameters

value	[OUT] The container for the returned value
throwIfNotFound	[DEF] If true, will throw an exception if there is no text in this element

Note

This is different than GetText() in that it will covert the text to what ever type you want

This only works if the Text is the FirstChild node

Exceptions

Exception

When there is no text and throwIfNotFound is true

See also

GetText

GetTextOrDefault

GetTextOrDefault( T* value, const DefaultT& defaultValue )

TiXmlElement::GetText

Definition at line 1690 of file ticpp.h.

                                                              {
      // Get the element's text value as a std::string
      std::string temp;

      if (!GetTextImp(&temp)) {
        if (throwIfNotFound) {
          TICPPTHROW("Text does not exists in the current element");
        } else {
          return;
        }
      }

      // Stream the value from the string to T
      FromString(temp, value);
    }

GetTextImp()

bool Element::GetTextImp ( std::string *  value ) const

private

Definition at line 850 of file ticpp.cpp.

                                               {
  ValidatePointer();

  // Get value from TinyXML, if the attribute exists
  const char* retVal = m_tiXmlPointer->GetText();

  // TinyXML returns nullptr if the attribute doesn't exist
  if (0 == retVal) {
    return false;
  } else {
    *value = retVal;
    return true;
  }
}

GetTextOrDefault() [1/2]

std::string ticpp::Element::GetTextOrDefault ( const std::string &  defaultValue ) const

inline

Gets the text of an Element, if it doesn't exist it will return the defaultValue.

Parameters

defaultValue

What to put in 'value' if there is no text in this element

Note

This only works if the Text is the FirstChild node

See also

GetText

GetText( T* value, bool throwIfNotFound = false )

GetTextOrDefault( T* value, const DefaultT& defaultValue )

TiXmlElement::GetText

Definition at line 1626 of file ticpp.h.

                                                                    {
      // Get the element's text value as a std::string
      std::string temp;

      if (!GetTextImp(&temp)) {
        return defaultValue;
      }

      return temp;
    }

GetTextOrDefault() [2/2]

template<class T , class DefaultT >

void ticpp::Element::GetTextOrDefault ( T *  value, const DefaultT &  defaultValue  ) const

inline

Gets the text value of an Element, if it doesn't exist it will return the defaultValue.

Uses FromString to convert the string to the type of choice

Parameters

value	[OUT] The container for the returned value
defaultValue	What to put in 'value' if there is no text in this element

Note

This is different than GetText() in that it will covert the text to what ever type you want.

This only works if the Text is the FirstChild node

See also

GetText

GetText( T* value, bool throwIfNotFound = false )

GetTextOrDefault( const std::string& defaultValue )

TiXmlElement::GetText

Definition at line 1656 of file ticpp.h.

                                                                        {
      // Get the element's text value as a std::string
      std::string temp;

      if (!GetTextImp(&temp)) {
        // The text value does not exist - set value to the default
        *value = defaultValue;
        return;
      }

      // Stream the value from the string to T
      FromString(temp, value);
    }

GetTiXmlPointer()

TiXmlNode* ticpp::NodeImp< TiXmlElement >::GetTiXmlPointer ( ) const

inlineprotectedvirtualinherited

Implements ticpp::Node.

Definition at line 1271 of file ticpp.h.

                                       {
      ValidatePointer();
      return m_tiXmlPointer;
    }

GetValue()

template<class T >

void ticpp::Node::GetValue ( T *  value ) const

inlineinherited

Get the value of this node Uses Base::FromString to convert TiXmlNode::ValueStr from a std::string, and puts it in the passed pointer.

Parameters

value

[OUT] A pointer to fill with the value

Definition at line 470 of file ticpp.h.

                                  {
      FromString(GetTiXmlPointer()->ValueStr(), value);
    }

HasAttribute()

bool Element::HasAttribute

(

const std::string &

name

)

const

Returns true, if attribute exists.

Parameters

name	The name of the attribute you are checking.

Returns

Existence of attribute

Definition at line 825 of file ticpp.cpp.

                                                      {
  ValidatePointer();
  return (0 != m_tiXmlPointer->Attribute(name.c_str()));
}

InsertAfterChild()

Node * Node::InsertAfterChild ( Node *  afterThis, Node &  addThis  )

inherited

Adds a child after the specified child.

Throws if you try to insert a document.

Parameters

afterThis	Node that will have addThis linked after.
addThis	Node to insert after.

Exceptions

Exception

When TiXmlNode::InsertAfterChild returns Null.

See also

InsertBeforeChild

TiXmlNode::InsertAfterChild

Definition at line 365 of file ticpp.cpp.

References TiXmlNode::DOCUMENT, ticpp::Node::GetTiXmlPointer(), TiCppRCImp::IncRef(), TiXmlNode::InsertAfterChild(), ticpp::Base::m_impRC, ticpp::Node::NodeFactory(), and ticpp::Node::Type().

                                                           {
  if (addThis.Type() == TiXmlNode::DOCUMENT) {
    TICPPTHROW("Node is a Document and can't be inserted");
  }

  // Increment reference count when adding to the tree
  addThis.m_impRC->IncRef();

  TiXmlNode* pointer = GetTiXmlPointer()->InsertAfterChild(
    afterThis->GetTiXmlPointer(), *addThis.GetTiXmlPointer());

  if (0 == pointer) {
    TICPPTHROW("Node can't be inserted");
  }

  return NodeFactory(pointer);
}

Here is the call graph for this function:

InsertBeforeChild()

Node * Node::InsertBeforeChild ( Node *  beforeThis, Node &  addThis  )

inherited

Adds a child before the specified child.

Throws if you try to insert a document.

Parameters

beforeThis	Node that will have addThis linked before.
addThis	Node to insert before.

Exceptions

Exception

When TiXmlNode::InsertBeforeChild returns Null.

See also

InsertAfterChild

TiXmlNode::InsertBeforeChild

Definition at line 347 of file ticpp.cpp.

References TiXmlNode::DOCUMENT, ticpp::Node::GetTiXmlPointer(), TiCppRCImp::IncRef(), TiXmlNode::InsertBeforeChild(), ticpp::Base::m_impRC, ticpp::Node::NodeFactory(), and ticpp::Node::Type().

                                                             {
  if (addThis.Type() == TiXmlNode::DOCUMENT) {
    TICPPTHROW("Node is a Document and can't be inserted");
  }

  // Increment reference count when adding to the tree
  addThis.m_impRC->IncRef();

  TiXmlNode* pointer = GetTiXmlPointer()->InsertBeforeChild(
    beforeThis->GetTiXmlPointer(), *addThis.GetTiXmlPointer());

  if (0 == pointer) {
    TICPPTHROW("Node can't be inserted");
  }

  return NodeFactory(pointer);
}

Here is the call graph for this function:

InsertEndChild()

Node * Node::InsertEndChild ( Node &  addThis )

inherited

Adds a child past the LastChild.

Throws if you try to insert a document.

Note

This takes a copy of addThis so it is not as efficiant as LinkEndChild.

Parameters

addThis

Node to insert.

Exceptions

Exception

When TiXmlNode::InsertEndChild returns Null

See also

LinkEndChild

TiXmlNode::InsertEndChild

Definition at line 317 of file ticpp.cpp.

References TiXmlNode::DOCUMENT, ticpp::Node::GetTiXmlPointer(), TiXmlNode::InsertEndChild(), ticpp::Node::NodeFactory(), and ticpp::Node::Type().

                                        {
  if (addThis.Type() == TiXmlNode::DOCUMENT) {
    TICPPTHROW("Node is a Document and can't be inserted");
  }

  TiXmlNode* pointer =
    GetTiXmlPointer()->InsertEndChild(*addThis.GetTiXmlPointer());

  if (0 == pointer) {
    TICPPTHROW("Node can't be inserted");
  }

  return NodeFactory(pointer);
}

Here is the call graph for this function:

IterateChildren() [1/2]

Node * Node::IterateChildren ( Node *  previous ) const

inherited

An alternate way to walk the children of a node.

Simple wrapper for TiXmlNode::IterateChildren.

Parameters

previous

The previous Node* that was returned from IterateChildren.

Returns

nullptr When there are no more children.

Definition at line 292 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), TiXmlNode::IterateChildren(), and ticpp::Node::NodeFactory().

                                                {
  TiXmlNode* pointer;

  if (0 == previous) {
    pointer = GetTiXmlPointer()->IterateChildren(0);
  } else {
    pointer = GetTiXmlPointer()->IterateChildren(previous->GetTiXmlPointer());
  }

  return NodeFactory(pointer, false);
}

Here is the call graph for this function:

IterateChildren() [2/2]

Node * Node::IterateChildren ( const std::string &  value, Node *  previous  ) const

inherited

This flavor of IterateChildren searches for children with a particular value.

Simple wrapper for TiXmlNode::IterateChildren.

Parameters

value	The value you want to search for.
previous	The previous Node* that was returned from IterateChildren.

Returns

nullptr When there are no more children.

Definition at line 304 of file ticpp.cpp.

References ticpp::Node::NodeFactory().

                                                                        {
  TiXmlNode* pointer;

  if (0 == previous) {
    pointer = GetTiXmlPointer()->IterateChildren(value, 0);
  } else {
    pointer =
      GetTiXmlPointer()->IterateChildren(value, previous->GetTiXmlPointer());
  }

  return NodeFactory(pointer, false);
}

Here is the call graph for this function:

IterateFirst() [1/2]

template<class T >

void ticpp::Node::IterateFirst ( const std::string &  value, T **  first  ) const

inlineinherited

Definition at line 783 of file ticpp.h.

                                                               {
      *first = 0;

      for (Node* child = FirstChild(value, false); child;
           child = child->NextSibling(value, false)) {
        *first = dynamic_cast< T* >(child);

        if (0 != *first) {
          return;
        }
      }
    }

IterateFirst() [2/2]

void ticpp::Element::IterateFirst ( const std::string &  , Attribute **  first  ) const

inlinevirtual

Reimplemented from ticpp::Node.

Definition at line 1558 of file ticpp.h.

References FirstAttribute(), and ticpp::Attribute::Next().

                                                                 {
      *first = 0;

      for (Attribute* child = FirstAttribute(false); child;
           child = child->Next(false)) {
        *first = dynamic_cast< Attribute* >(child);

        if (0 != *first) {
          return;
        }
      }
    }

Here is the call graph for this function:

IterateNext()

template<class T >

void ticpp::Node::IterateNext ( const std::string &  value, T **  next  ) const

inlineinherited

Definition at line 808 of file ticpp.h.

                                                             {
      Node* sibling = NextSibling(value, false);
      *next = dynamic_cast< T* >(sibling);

      while ((0 != sibling) && (0 == *next)) {
        sibling = sibling->NextSibling(value, false);
        *next = dynamic_cast< T* >(sibling);
      }
    }

IteratePrevious()

template<class T >

void ticpp::Node::IteratePrevious ( const std::string &  value, T **  previous  ) const

inlineinherited

Definition at line 826 of file ticpp.h.

                                                                     {
      Node* sibling = PreviousSibling(value, false);
      *previous = dynamic_cast< T* >(sibling);

      while ((0 != sibling) && (0 == *previous)) {
        sibling = sibling->PreviousSibling(value, false);
        *previous = dynamic_cast< T* >(sibling);
      }
    }

LastAttribute()

Attribute * Element::LastAttribute

(

bool

throwIfNoAttributes = true

)

const

Access the last attribute in this element.

Parameters

throwIfNoAttributes

[DEF] If true, throws when there are no attributes

Returns

The last attribute, nullptr if there are none and throwIfNoAttributes is true

Definition at line 788 of file ticpp.cpp.

References ticpp::Attribute::Attribute().

                                                                {
  ValidatePointer();
  TiXmlAttribute* attribute = m_tiXmlPointer->LastAttribute();

  if ((0 == attribute) && throwIfNoAttributes) {
    TICPPTHROW("This Element (" << Value() << ") has no attributes")
  }

  if (0 == attribute) {
    if (throwIfNoAttributes) {
      TICPPTHROW("Element (" << Value() << ") has no attributes")
    } else {
      return 0;
    }
  }

  Attribute* temp = new Attribute(attribute);
  attribute->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

LastChild() [1/3]

Node * Node::LastChild ( bool  throwIfNoChildren = true ) const

inherited

The last child of this node.

Parameters

throwIfNoChildren

[DEF] If true, will throw an exception if there are no children.

Returns

Pointer to child, Null if no children and 'throwIfNoChildren' is false.

Exceptions

Exception

When throwIfNoChildren is true, and TiXmlNode::LastChild returns Null.

See also

TiXmlNode::LastChild

Definition at line 268 of file ticpp.cpp.

References ticpp::Node::LastChild().

                                                  {
  return LastChild("", throwIfNoChildren);
}

Here is the call graph for this function:

LastChild() [2/3]

Node * Node::LastChild ( const char *  value, bool  throwIfNoChildren = true  ) const

inherited

Definition at line 276 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), TiXmlNode::LastChild(), and ticpp::Node::NodeFactory().

Referenced by ticpp::Node::LastChild().

                                                                     {
  TiXmlNode* childNode;

  if (0 == strlen(value)) {
    childNode = GetTiXmlPointer()->LastChild();
  } else {
    childNode = GetTiXmlPointer()->LastChild(value);
  }

  if ((0 == childNode) && throwIfNoChildren) {
    TICPPTHROW("Child with the value of \"" << value << "\" not found");
  }

  return NodeFactory(childNode, false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

LastChild() [3/3]

Node * Node::LastChild ( const std::string &  value, bool  throwIfNoChildren = true  ) const

inherited

The last child of this node with the matching value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	Value to match.
throwIfNoChildren	[DEF] If true, will throw an exception if there are no children.

See also

LastChild( const char* value, bool throwIfNoChildren = true )

Definition at line 272 of file ticpp.cpp.

                                                                          {
  return LastChild(value.c_str(), throwIfNoChildren);
}

LinkEndChild()

Node * Node::LinkEndChild ( Node *  childNode )

inherited

Adds a child past the LastChild.

Throws if you try to link a document.

Parameters

childNode

Node to link.

Exceptions

Exception

When TiXmlNode::LinkEndChild returns Null.

See also

InsertEndChild

TiXmlNode::LinkEndChild

Definition at line 332 of file ticpp.cpp.

References TiXmlNode::DOCUMENT, ticpp::Node::GetTiXmlPointer(), TiCppRCImp::IncRef(), TiXmlNode::LinkEndChild(), ticpp::Base::m_impRC, and ticpp::Node::Type().

                                        {
  if (childNode->Type() == TiXmlNode::DOCUMENT) {
    TICPPTHROW("Node is a Document and can't be linked");
  }

  // Increment reference count when adding to the tree
  childNode->m_impRC->IncRef();

  if (0 == GetTiXmlPointer()->LinkEndChild(childNode->GetTiXmlPointer())) {
    TICPPTHROW("Node can't be linked");
  }

  return childNode;
}

Here is the call graph for this function:

NextSibling() [1/3]

Node * Node::NextSibling ( bool  throwIfNoSiblings = true ) const

inherited

Navigate to a sibling node.

Wrapper around TiXmlNode::NextSibling.

Parameters

throwIfNoSiblings

[DEF] If true, will throw an exception if there are no siblings.

Returns

Pointer to sibling, Null if no siblings and 'throwIfNoSiblings' is false.

Exceptions

Exception

When TiXmlNode::NextSibling returns Null and 'throwIfNoSiblings' is true.

Definition at line 438 of file ticpp.cpp.

References ticpp::Node::NextSibling().

                                                    {
  return NextSibling("", throwIfNoSiblings);
}

Here is the call graph for this function:

NextSibling() [2/3]

Node * Node::NextSibling ( const std::string &  value, bool  throwIfNoSiblings = true  ) const

inherited

Navigate to a sibling node with the given value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	The value of the node to look for.
throwIfNoSiblings	[DEF] If true, will throw an exception if there are no siblings.

See also

NextSibling( bool throwIfNoSiblings )

Definition at line 442 of file ticpp.cpp.

                                                                            {
  return NextSibling(value.c_str(), throwIfNoSiblings);
}

NextSibling() [3/3]

Node * Node::NextSibling ( const char *  value, bool  throwIfNoSiblings = true  ) const

inherited

Definition at line 446 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), TiXmlNode::NextSibling(), and ticpp::Node::NodeFactory().

Referenced by ticpp::Node::NextSibling().

                                                                       {
  TiXmlNode* sibling;

  if (0 == strlen(value)) {
    sibling = GetTiXmlPointer()->NextSibling();
  } else {
    sibling = GetTiXmlPointer()->NextSibling(value);
  }

  if ((0 == sibling) && throwIfNoSiblings) {
    TICPPTHROW("No Siblings found with value, '" << value << "', After this Node ("
                                                 << Value()
                                                 << ")")
  }

  return NodeFactory(sibling, false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

NextSiblingElement() [1/3]

Element * Node::NextSiblingElement ( bool  throwIfNoSiblings = true ) const

inherited

Navigate to a sibling element.

Wrapper around TiXmlNode::NextSibling.

Parameters

throwIfNoSiblings

[DEF] If true, will throw an exception if there are no sibling element.

Returns

Pointer to sibling, Null if no siblings and 'throwIfNoSiblings' is false.

Exceptions

Exception

When TiXmlNode::NextSibling returns Null and 'throwIfNoSiblings' is true.

Definition at line 464 of file ticpp.cpp.

References ticpp::Node::NextSiblingElement().

                                                              {
  return NextSiblingElement("", throwIfNoSiblings);
}

Here is the call graph for this function:

NextSiblingElement() [2/3]

Element * Node::NextSiblingElement ( const std::string &  value, bool  throwIfNoSiblings = true  ) const

inherited

Navigate to a sibling element with the given value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	The value of the element to look for.
throwIfNoSiblings	[DEF] If true, will throw an exception if there are no sibling elements.

See also

NextSiblingElement( bool throwIfNoSiblings )

Definition at line 468 of file ticpp.cpp.

                                                                              {
  return NextSiblingElement(value.c_str(), throwIfNoSiblings);
}

NextSiblingElement() [3/3]

Element * Node::NextSiblingElement ( const char *  value, bool  throwIfNoSiblings = true  ) const

inherited

Definition at line 473 of file ticpp.cpp.

References Element(), ticpp::Node::GetTiXmlPointer(), and TiXmlNode::NextSiblingElement().

Referenced by ticpp::Node::NextSiblingElement().

                                                                       {
  TiXmlElement* sibling;

  if (0 == strlen(value)) {
    sibling = GetTiXmlPointer()->NextSiblingElement();
  } else {
    sibling = GetTiXmlPointer()->NextSiblingElement(value);
  }

  if (0 == sibling) {
    if (throwIfNoSiblings) {
      TICPPTHROW("No Element Siblings found with value, '"
                 << value
                 << "', After this Node ("
                 << Value()
                 << ")")
    } else {
      return 0;
    }
  }

  Element* temp = new Element(sibling);
  sibling->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

NoChildren()

bool Node::NoChildren ( ) const

inherited

Check if this node has no children.

Returns

true if this node has no children.

Definition at line 555 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), and TiXmlNode::NoChildren().

{ return GetTiXmlPointer()->NoChildren(); }

Here is the call graph for this function:

NodeFactory()

Node * Node::NodeFactory ( TiXmlNode *  tiXmlNode, bool  throwIfNull = true, bool  rememberSpawnedWrapper = true  ) const

protectedinherited

Definition at line 181 of file ticpp.cpp.

References TiXmlNode::Type().

Referenced by ticpp::Node::FirstChild(), ticpp::Node::InsertAfterChild(), ticpp::Node::InsertBeforeChild(), ticpp::Node::InsertEndChild(), ticpp::Node::IterateChildren(), ticpp::Node::LastChild(), ticpp::Node::NextSibling(), ticpp::Node::Parent(), ticpp::Node::PreviousSibling(), and ticpp::Node::ReplaceChild().

                                                                 {
  if (0 == tiXmlNode) {
    if (throwIfNull) {
      TICPPTHROW("tiXmlNode is nullptr")
    } else {
      return 0;
    }
  }

  Node* temp;

  switch (tiXmlNode->Type()) {
    case TiXmlNode::DOCUMENT:
      temp = new Document(tiXmlNode->ToDocument());
      break;

    case TiXmlNode::ELEMENT:
      temp = new Element(tiXmlNode->ToElement());
      break;

    case TiXmlNode::COMMENT:
      temp = new Comment(tiXmlNode->ToComment());
      break;

    case TiXmlNode::TEXT:
      temp = new Text(tiXmlNode->ToText());
      break;

    case TiXmlNode::DECLARATION:
      temp = new Declaration(tiXmlNode->ToDeclaration());
      break;

    case TiXmlNode::STYLESHEETREFERENCE:
      temp = new StylesheetReference(tiXmlNode->ToStylesheetReference());
      break;

    default:
      TICPPTHROW("Type is unsupported")
  }

  if (rememberSpawnedWrapper) {
    tiXmlNode->m_spawnedWrappers.push_back(temp);
  }

  return temp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool ticpp::Base::operator!= ( const Base &  rhs ) const

inlineinherited

Compare internal TiXml pointers to determine is both are wrappers around the same node.

Definition at line 231 of file ticpp.h.

References ticpp::Base::GetBasePointer().

                                           {
      return (GetBasePointer() != rhs.GetBasePointer());
    }

Here is the call graph for this function:

operator==()

bool ticpp::Base::operator== ( const Base &  rhs ) const

inlineinherited

Compare internal TiXml pointers to determine is both are wrappers around the same node.

Definition at line 222 of file ticpp.h.

References ticpp::Base::GetBasePointer().

                                           {
      return (GetBasePointer() == rhs.GetBasePointer());
    }

Here is the call graph for this function:

Parent()

Node * Node::Parent ( bool  throwIfNoParent = true ) const

inherited

The Parent of this Node.

Simple wrapper for TiXmlNode::Parent.

Parameters

throwIfNoParent

[DEF] If true, throws when Parent = nullptr.

Returns

The parent of this node, nullptr if there is no Parent.

Exceptions

Exception

When throwIfNoParent is true, and TiXmlNode::Parent returns Null.

Definition at line 234 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), ticpp::Node::NodeFactory(), and TiXmlNode::Parent().

                                             {
  TiXmlNode* parent = GetTiXmlPointer()->Parent();

  if ((0 == parent) && throwIfNoParent) {
    TICPPTHROW("No parent exists");
  }

  return NodeFactory(parent, false);
}

Here is the call graph for this function:

PreviousSibling() [1/3]

Node * Node::PreviousSibling ( bool  throwIfNoSiblings = true ) const

inherited

Navigate to a sibling node.

Wrapper around TiXmlNode::PreviousSibling.

Parameters

throwIfNoSiblings

[DEF] If true, will throw an exception if there are no siblings.

Returns

Pointer to sibling, Null if no siblings and 'throwIfNoSiblings' is false.

Exceptions

Exception

When TiXmlNode::PreviousSibling returns Null and 'throwIfNoSiblings' is true.

Definition at line 410 of file ticpp.cpp.

References ticpp::Node::PreviousSibling().

                                                        {
  return PreviousSibling("", throwIfNoSiblings);
}

Here is the call graph for this function:

PreviousSibling() [2/3]

Node * Node::PreviousSibling ( const std::string &  value, bool  throwIfNoSiblings = true  ) const

inherited

Navigate to a sibling node with the given value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

value	The value of the node to look for.
throwIfNoSiblings	[DEF] If true, will throw an exception if there are no siblings.

See also

PreviousSibling( bool throwIfNoSiblings )

Definition at line 414 of file ticpp.cpp.

                                                                        {
  return PreviousSibling(value.c_str(), throwIfNoSiblings);
}

PreviousSibling() [3/3]

Node * Node::PreviousSibling ( const char *  value, bool  throwIfNoSiblings = true  ) const

inherited

Definition at line 419 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), ticpp::Node::NodeFactory(), and TiXmlNode::PreviousSibling().

Referenced by ticpp::Node::PreviousSibling().

                                                                           {
  TiXmlNode* sibling;

  if (0 == strlen(value)) {
    sibling = GetTiXmlPointer()->PreviousSibling();
  } else {
    sibling = GetTiXmlPointer()->PreviousSibling(value);
  }

  if ((0 == sibling) && throwIfNoSiblings) {
    TICPPTHROW("No Siblings found with value, '" << value
                                                 << "', Prior to this Node ("
                                                 << Value()
                                                 << ")")
  }

  return NodeFactory(sibling, false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveAttribute()

void Element::RemoveAttribute

(

const std::string &

name

)

Removes attribute from element.

Parameters

name	The name of the attribute to remove.

Definition at line 830 of file ticpp.cpp.

                                                   {
  ValidatePointer();
  m_tiXmlPointer->RemoveAttribute(name.c_str());
}

RemoveChild()

void Node::RemoveChild ( Node *  removeThis )

inherited

Delete a child of this node.

Parameters

removeThis

Node to delete.

Exceptions

Exception

When removeThis is not a child of this Node.

See also

TiXmlNode::RemoveChild

Definition at line 401 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), and TiXmlNode::RemoveChild().

                                       {
  if (!GetTiXmlPointer()->RemoveChild(removeThis->GetTiXmlPointer())) {
    TICPPTHROW("Node to remove (" << removeThis->Value()
                                  << ") is not a child of this Node ("
                                  << Value()
                                  << ")")
  }
}

Here is the call graph for this function:

ReplaceChild()

Node * Node::ReplaceChild ( Node *  replaceThis, Node &  withThis  )

inherited

Replace a child of this node.

Throws if you try to replace with a document.

Parameters

replaceThis	Node to replace.
withThis	Node that is replacing replaceThis.

Exceptions

Exception

When TiXmlNode::ReplaceChild returns Null.

See also

TiXmlNode::ReplaceChild

Definition at line 383 of file ticpp.cpp.

References TiXmlNode::DOCUMENT, ticpp::Node::GetTiXmlPointer(), TiCppRCImp::IncRef(), ticpp::Base::m_impRC, ticpp::Node::NodeFactory(), TiXmlNode::ReplaceChild(), and ticpp::Node::Type().

                                                          {
  if (withThis.Type() == TiXmlNode::DOCUMENT) {
    TICPPTHROW("Node is a Document and can't be inserted");
  }

  // Increment reference count when adding to the tree
  withThis.m_impRC->IncRef();

  TiXmlNode* pointer = GetTiXmlPointer()->ReplaceChild(
    replaceThis->GetTiXmlPointer(), *withThis.GetTiXmlPointer());

  if (0 == pointer) {
    TICPPTHROW("Node can't be inserted");
  }

  return NodeFactory(pointer);
}

Here is the call graph for this function:

Row()

int ticpp::Base::Row ( ) const

inlineinherited

Return the position, in the original source file, of this node or attribute.

Wrapper around TiXmlBase::Row()

Definition at line 209 of file ticpp.h.

References ticpp::Base::GetBasePointer(), and TiXmlBase::Row().

{ return GetBasePointer()->Row(); }

Here is the call graph for this function:

SetAttribute()

template<class T >

void ticpp::Element::SetAttribute ( const std::string &  name, const T &  value  )

inline

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does. Uses ToString to convert the value to a string, so there is no need to use any other SetAttribute methods.

See also

GetAttribute

Definition at line 1581 of file ticpp.h.

                                                             {
      ValidatePointer();
      m_tiXmlPointer->SetAttribute(name, ToString(value));
    }

SetImpRC()

void ticpp::Base::SetImpRC ( TiXmlBase *  nodeBase )

inlineprotectedinherited

Definition at line 279 of file ticpp.h.

References ticpp::Base::m_impRC, and TiCppRC::m_tiRC.

Referenced by ticpp::NodeImp< TiXmlDeclaration >::SetTiXmlPointer().

{ m_impRC = nodeBase->m_tiRC; }

Here is the caller graph for this function:

SetText()

template<class T >

void ticpp::Element::SetText ( const T &  value )

inline

Convenience function to set the text of an element.

Creates a Text node and inserts it as the first child. Uses ToString to convert the parameter to a string.

Parameters

value

The text to set.

Definition at line 1714 of file ticpp.h.

                                 {
      ValidatePointer();
      std::string temp = ToString(value);

      if (m_tiXmlPointer->NoChildren()) {
        m_tiXmlPointer->LinkEndChild(new TiXmlText(temp));
      } else {
        if (0 == m_tiXmlPointer->GetText()) {
          m_tiXmlPointer->InsertBeforeChild(m_tiXmlPointer->FirstChild(),
                                            TiXmlText(temp));
        } else {
          // There already is text, so change it
          m_tiXmlPointer->FirstChild()->SetValue(temp);
        }
      }
    }

SetTiXmlPointer()

void ticpp::NodeImp< TiXmlElement >::SetTiXmlPointer ( TiXmlElement *  newPointer )

inlineprotectedinherited

Definition at line 1283 of file ticpp.h.

                                        {
      m_tiXmlPointer = newPointer;
      SetImpRC(newPointer);
    }

SetValue()

template<class T >

void ticpp::Node::SetValue ( const T &  value )

inlineinherited

Set the value of this node.

Uses Base::ToString to convert value to a std::string, then calls TiXmlNode::SetValue.

Parameters

value

The value to set

Definition at line 490 of file ticpp.h.

                                  {
      GetTiXmlPointer()->SetValue(ToString(value));
    }

To()

template<class T >

T* ticpp::Node::To ( ) const

inlineinherited

Pointer conversion ( NOT OBJECT CONVERSION ) - replaces TiXmlNode::ToElement, TiXmlNode::ToDocument, TiXmlNode::ToComment, etc.

Exceptions

Exception

When the target is not an object of class T

Warning

Some ancient compilers do not support explicit specification of member template arguments, which this depends on ( e.g. VC6 ).

Definition at line 961 of file ticpp.h.

                  {
      T* pointer = dynamic_cast< T* >(this);

      if (0 == pointer) {
        std::string thisType = typeid(this).name();
        std::string targetType = typeid(T).name();
        std::string thatType = typeid(*this).name();
        TICPPTHROW("The " << thisType.substr(6) << " could not be casted to a "
                          << targetType.substr(6)
                          << " *, because the target object is not a "
                          << targetType.substr(6)
                          << ". (It is a "
                          << thatType.substr(6)
                          << ")");
      }

      return pointer;
    }

ToComment()

Comment * Node::ToComment ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToComment.

Exceptions

Exception

When this node is not a Comment.

Definition at line 583 of file ticpp.cpp.

References ticpp::Comment::Comment(), ticpp::Node::GetTiXmlPointer(), and TiXmlNode::ToComment().

                               {
  TiXmlComment* doc = GetTiXmlPointer()->ToComment();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a Comment")
  }

  Comment* temp = new Comment(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

ToDeclaration()

Declaration * Node::ToDeclaration ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToDeclaration.

Exceptions

Exception

When this node is not a Declaration.

Definition at line 609 of file ticpp.cpp.

References ticpp::Declaration::Declaration(), ticpp::Node::GetTiXmlPointer(), and TiXmlNode::ToDeclaration().

                                       {
  TiXmlDeclaration* doc = GetTiXmlPointer()->ToDeclaration();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a Declaration")
  }

  Declaration* temp = new Declaration(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

ToDocument()

Document * Node::ToDocument ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToDocument.

Exceptions

Exception

When this node is not a Document.

Definition at line 557 of file ticpp.cpp.

References ticpp::Document::Document().

                                 {
  TiXmlDocument* doc = GetTiXmlPointer()->ToDocument();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a Document")
  }

  Document* temp = new Document(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

ToElement()

Element * Node::ToElement ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToElement.

Exceptions

Exception

When this node is not a Element.

Definition at line 570 of file ticpp.cpp.

References Element(), ticpp::Node::GetTiXmlPointer(), and TiXmlNode::ToElement().

                               {
  TiXmlElement* doc = GetTiXmlPointer()->ToElement();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a Element")
  }

  Element* temp = new Element(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

ToString() [1/2]

template<class T >

std::string ticpp::Base::ToString ( const T &  value ) const

inlineinherited

Converts any class with a proper overload of the << opertor to a std::string.

Parameters

value

The value to be converted

Exceptions

Exception

When value cannot be converted to a std::string

Definition at line 169 of file ticpp.h.

                                             {
      std::stringstream convert;
      convert << value;

      if (convert.fail()) {
        TICPPTHROW("Could not convert value to text");
      }

      return convert.str();
    }

ToString() [2/2]

std::string ticpp::Base::ToString ( const std::string &  value ) const

inlineinherited

Definition at line 180 of file ticpp.h.

{ return value; }

ToStylesheetReference()

StylesheetReference * Node::ToStylesheetReference ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToStylesheetReference.

Exceptions

Exception

When this node is not a StylesheetReference.

Definition at line 622 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), ticpp::StylesheetReference::StylesheetReference(), and TiXmlNode::ToStylesheetReference().

                                                       {
  TiXmlStylesheetReference* doc = GetTiXmlPointer()->ToStylesheetReference();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a StylesheetReference")
  }

  StylesheetReference* temp = new StylesheetReference(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

ToText()

Text * Node::ToText ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToText.

Exceptions

Exception

When this node is not a Text.

Definition at line 596 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), ticpp::Text::Text(), TiXmlText::TiXmlElement, and TiXmlNode::ToText().

                         {
  TiXmlText* doc = GetTiXmlPointer()->ToText();

  if (0 == doc) {
    TICPPTHROW("This node (" << Value() << ") is not a Text")
  }

  Text* temp = new Text(doc);
  doc->m_spawnedWrappers.push_back(temp);

  return temp;
}

Here is the call graph for this function:

Type()

int Node::Type ( ) const

inherited

Query the type (as TiXmlNode::NodeType ) of this node.

Definition at line 536 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), and TiXmlNode::Type().

Referenced by ticpp::Node::InsertAfterChild(), ticpp::Node::InsertBeforeChild(), ticpp::Node::InsertEndChild(), ticpp::Node::LinkEndChild(), and ticpp::Node::ReplaceChild().

{ return GetTiXmlPointer()->Type(); }

Here is the call graph for this function:

Here is the caller graph for this function:

ValidatePointer()

void ticpp::Base::ValidatePointer ( ) const

inlineprotectedinherited

Definition at line 281 of file ticpp.h.

References TiCppRCImp::IsNull(), and ticpp::Base::m_impRC.

Referenced by ticpp::Attribute::GetBasePointer(), ticpp::Attribute::GetName(), ticpp::NodeImp< TiXmlDeclaration >::GetTiXmlPointer(), ticpp::Attribute::GetValue(), ticpp::Attribute::Name(), ticpp::Attribute::Next(), ticpp::Attribute::Previous(), ticpp::Attribute::Print(), ticpp::Attribute::SetName(), ticpp::Attribute::SetValue(), and ticpp::Attribute::Value().

                                 {
      if (m_impRC->IsNull()) {
        TICPPTHROW("Internal TiXml Pointer is nullptr");
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Value()

std::string Node::Value ( ) const

inherited

Get the value of this node.

Simple wrapper for TiXmlNode::ValueStr.

See also

GetValue

Definition at line 230 of file ticpp.cpp.

References ticpp::Node::GetTiXmlPointer(), and TiXmlNode::ValueStr().

{ return GetTiXmlPointer()->ValueStr(); }

Here is the call graph for this function:

Member Data Documentation

m_impRC

TiCppRCImp* ticpp::Base::m_impRC

mutableprotectedinherited

Holds status of internal TiXmlPointer - use this to determine if object has been deleted already.

Definition at line 267 of file ticpp.h.

Referenced by ticpp::Attribute::Attribute(), ticpp::Node::InsertAfterChild(), ticpp::Node::InsertBeforeChild(), ticpp::Node::LinkEndChild(), ticpp::NodeImp< TiXmlDeclaration >::NodeImp(), ticpp::Attribute::operator=(), ticpp::Node::ReplaceChild(), ticpp::Base::SetImpRC(), ticpp::Base::ValidatePointer(), ticpp::Attribute::~Attribute(), and ticpp::NodeImp< TiXmlDeclaration >::~NodeImp().

m_tiXmlPointer

TiXmlElement * ticpp::NodeImp< TiXmlElement >::m_tiXmlPointer

protectedinherited

Internal pointer to the TiXml Class which is being wrapped.

Definition at line 1262 of file ticpp.h.

---

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

• agrum/tools/external/tinyxml/ticpp/ticpp.h
• agrum/tools/external/tinyxml/ticpp/ticpp.cpp