ticpp::StylesheetReference Class Reference

Wrapper around TiXmlStylesheetReference. More...

#include <ticpp.h>

Inheritance diagram for ticpp::StylesheetReference:

Collaboration diagram for ticpp::StylesheetReference:

Public Member Functions
	StylesheetReference ()
	Default Constructor.
	StylesheetReference (TiXmlStylesheetReference *stylesheetReference)
	Constructor.
	StylesheetReference (const std::string &type, const std::string &href)
	Constructor.
std::string	Type () const
	Type.
std::string	Href () const
	Href.
void	GetValue (TiXmlStylesheetReference *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.
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.
std::string	Value () const
	Get the value of this node.
void	SetValue (const TiXmlStylesheetReference &value)
	Set the value of this node.
template<class T>
void	SetValue (const T &value)
	Set the value of this node.
void	Clear ()
	Clear all Nodes below this.
Node *	Parent (bool throwIfNoParent=true) const
	The Parent of this Node.
Node *	FirstChild (bool throwIfNoChildren=true) const
	The first child of this node.
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.
Node *	LastChild (bool throwIfNoChildren=true) const
	The last child of this node.
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.
Node *	IterateChildren (Node *previous) const
	An alternate way to walk the children of a node.
Node *	IterateChildren (const std::string &value, Node *previous) const
	This flavor of IterateChildren searches for children with a particular value.
Node *	InsertEndChild (Node &addThis)
	Adds a child past the LastChild.
Node *	LinkEndChild (Node *childNode)
	Adds a child past the LastChild.
Node *	InsertBeforeChild (Node *beforeThis, Node &addThis)
	Adds a child before the specified child.
Node *	InsertAfterChild (Node *afterThis, Node &addThis)
	Adds a child after the specified child.
Node *	ReplaceChild (Node *replaceThis, Node &withThis)
	Replace a child of this node.
void	RemoveChild (Node *removeThis)
	Delete a child of this node.
Node *	PreviousSibling (bool throwIfNoSiblings=true) const
	Navigate to a sibling node.
Node *	PreviousSibling (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling node with the given value.
Node *	PreviousSibling (const char *value, bool throwIfNoSiblings=true) const
Node *	NextSibling (bool throwIfNoSiblings=true) const
	Navigate to a sibling node.
Node *	NextSibling (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling node with the given value.
Node *	NextSibling (const char *value, bool throwIfNoSiblings=true) const
void	IterateFirst (const std::string &value, TiXmlStylesheetReference **first) const
virtual void	IterateFirst (const std::string &, Attribute **) const
void	IterateNext (const std::string &value, TiXmlStylesheetReference **next) const
template<class T>
void	IterateNext (const std::string &value, T **next) const
void	IteratePrevious (const std::string &value, TiXmlStylesheetReference **previous) const
template<class T>
void	IteratePrevious (const std::string &value, T **previous) const
Element *	NextSiblingElement (bool throwIfNoSiblings=true) const
	Navigate to a sibling element.
Element *	NextSiblingElement (const std::string &value, bool throwIfNoSiblings=true) const
	Navigate to a sibling element with the given value.
Element *	NextSiblingElement (const char *value, bool throwIfNoSiblings=true) const
Element *	FirstChildElement (bool throwIfNoChildren=true) const
	The first child element of this node.
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.
Document *	GetDocument (bool throwIfNoDocument=true) const
	Return a pointer to the Document this node lives in.
bool	NoChildren () const
	Check if this node has no children.
TiXmlStylesheetReference *	To () const
	Pointer conversion ( NOT OBJECT CONVERSION ) - replaces TiXmlNode::ToElement, TiXmlNode::ToDocument, TiXmlNode::ToComment, etc.
Document *	ToDocument () const
	Pointer conversion - replaces TiXmlNode::ToDocument.
Element *	ToElement () const
	Pointer conversion - replaces TiXmlNode::ToElement.
Comment *	ToComment () const
	Pointer conversion - replaces TiXmlNode::ToComment.
Text *	ToText () const
	Pointer conversion - replaces TiXmlNode::ToText.
Declaration *	ToDeclaration () const
	Pointer conversion - replaces TiXmlNode::ToDeclaration.
StylesheetReference *	ToStylesheetReference () const
	Pointer conversion - replaces TiXmlNode::ToStylesheetReference.
std::unique_ptr< Node >	Clone () const
	Create an exact duplicate of this node and return it.
bool	Accept (TiXmlVisitor *visitor) const
	Accept a hierchical visit the nodes in the TinyXML DOM.
std::string	ToString (const TiXmlStylesheetReference &value) const
	Converts any class with a proper overload of the << opertor to a std::string.
std::string	ToString (const std::string &value) const
void	FromString (const std::string &temp, TiXmlStylesheetReference *out) const
	Converts a std::string to any class with a proper overload of the >> opertor.
void	FromString (const std::string &temp, std::string *out) const
	Specialization for std::string.
int	Row () const
	Return the position, in the original source file, of this node or attribute.
int	Column () const
	Return the position, in the original source file, of this node or attribute.
bool	operator== (const Base &rhs) const
	Compare internal TiXml pointers to determine is both are wrappers around the same node.
bool	operator!= (const Base &rhs) const
	Compare internal TiXml pointers to determine is both are wrappers around the same node.
std::string	BuildDetailedErrorString () const
	Builds detailed error string using TiXmlDocument::Error() and others.

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

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

Detailed Description

Wrapper around TiXmlStylesheetReference.

Definition at line 1934 of file ticpp.h.

Constructor & Destructor Documentation

StylesheetReference() [1/3]

StylesheetReference::StylesheetReference

(

)

Default Constructor.

Construct an empty declaration.

Definition at line 893 of file ticpp.cpp.

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

References ticpp::NodeImp< TiXmlStylesheetReference >::NodeImp(), and ticpp::NodeImp< TiXmlStylesheetReference >::m_impRC.

Here is the call graph for this function:

StylesheetReference() [2/3]

StylesheetReference::StylesheetReference

(

TiXmlStylesheetReference *

stylesheetReference

)

Constructor.

Definition at line 898 of file ticpp.cpp.

    : NodeImp< TiXmlStylesheetReference >(stylesheetReference) {}

References ticpp::NodeImp< TiXmlStylesheetReference >::NodeImp().

Here is the call graph for this function:

StylesheetReference() [3/3]

StylesheetReference::StylesheetReference	(	const std::string &	type,
		const std::string &	href )

Constructor.

Definition at line 902 of file ticpp.cpp.

    : NodeImp< TiXmlStylesheetReference >(
        new TiXmlStylesheetReference(type, href)) {
  m_impRC->InitRef();
}

References ticpp::NodeImp< TiXmlStylesheetReference >::NodeImp().

Here is the call 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 1048 of file ticpp.cpp.

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

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.

                                               {
      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();
    }

Clear()

void Node::Clear ( )

inherited

Clear all Nodes below this.

Simple wrapper for TiXmlNode::Clear.

Definition at line 498 of file ticpp.cpp.

{ GetTiXmlPointer()->Clear(); }

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 1042 of file ticpp.cpp.

                                        {
  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;
}

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.

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

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 525 of file ticpp.cpp.

                                                   {
  return FirstChild("", throwIfNoChildren);
}

FirstChild() [2/3]

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

inherited

Definition at line 539 of file ticpp.cpp.

                                                                      {
  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);
}

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 552 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 892 of file ticpp.cpp.

                                                             {
  return FirstChildElement("", throwIfNoChildren);
}

FirstChildElement() [2/3]

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

inherited

Definition at line 906 of file ticpp.cpp.

                                                                                {
  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;
}

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 920 of file ticpp.cpp.

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

FromString() [1/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;
    }

FromString() [2/2]

void ticpp::Base::FromString ( const std::string & temp, TiXmlStylesheetReference * 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");
      }
    }

GetBasePointer()

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

inlineprotectedinherited

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 940 of file ticpp.cpp.

                                                        {
  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;
}

GetTiXmlPointer()

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

inlineprotectedvirtualinherited

Implements ticpp::Node.

Definition at line 1271 of file ticpp.h.

                                       {
      ValidatePointer();
      return m_tiXmlPointer;
    }

GetValue() [1/2]

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);
    }

References ticpp::Base::FromString(), and GetTiXmlPointer().

Here is the call graph for this function:

GetValue() [2/2]

void ticpp::Node::GetValue ( TiXmlStylesheetReference * 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);
    }

Href()

std::string StylesheetReference::Href

(

)

const

Href.

Will return an empty string if none was found.

Definition at line 911 of file ticpp.cpp.

{ return m_tiXmlPointer->Href(); }

References ticpp::NodeImp< TiXmlStylesheetReference >::m_tiXmlPointer.

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 667 of file ticpp.cpp.

                                                           {
  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);
}

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 654 of file ticpp.cpp.

                                                             {
  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);
}

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 629 of file ticpp.cpp.

                                        {
  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);
}

IterateChildren() [1/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 615 of file ticpp.cpp.

                                                                        {
  TiXmlNode* pointer;
 
  if (0 == previous) {
    pointer = GetTiXmlPointer()->IterateChildren(value, 0);
  } else {
    pointer =
      GetTiXmlPointer()->IterateChildren(value, previous->GetTiXmlPointer());
  }
 
  return NodeFactory(pointer, false);
}

IterateChildren() [2/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 604 of file ticpp.cpp.

                                                {
  TiXmlNode* pointer;
 
  if (0 == previous) {
    pointer = GetTiXmlPointer()->IterateChildren(0);
  } else {
    pointer = GetTiXmlPointer()->IterateChildren(previous->GetTiXmlPointer());
  }
 
  return NodeFactory(pointer, false);
}

IterateFirst() [1/2]

virtual void ticpp::Node::IterateFirst ( const std::string & , Attribute **  ) const

inlinevirtualinherited

Definition at line 796 of file ticpp.h.

                                                                   {
      TICPPTHROW("Attributes can only be iterated with Elements.")
    }

IterateFirst() [2/2]

void ticpp::Node::IterateFirst ( const std::string & value, TiXmlStylesheetReference ** 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;
        }
      }
    }

IterateNext() [1/2]

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);
      }
    }

References NextSibling().

Here is the call graph for this function:

IterateNext() [2/2]

void ticpp::Node::IterateNext ( const std::string & value, TiXmlStylesheetReference ** 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() [1/2]

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);
      }
    }

References PreviousSibling().

Here is the call graph for this function:

IteratePrevious() [2/2]

void ticpp::Node::IteratePrevious ( const std::string & value, TiXmlStylesheetReference ** 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);
      }
    }

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 568 of file ticpp.cpp.

                                                  {
  return LastChild("", throwIfNoChildren);
}

LastChild() [2/3]

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

inherited

Definition at line 582 of file ticpp.cpp.

                                                                     {
  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);
}

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 595 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 641 of file ticpp.cpp.

                                        {
  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;
}

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 745 of file ticpp.cpp.

                                                    {
  return NextSibling("", throwIfNoSiblings);
}

NextSibling() [2/3]

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

inherited

Definition at line 773 of file ticpp.cpp.

                                                                       {
  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);
}

NextSibling() [3/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 758 of file ticpp.cpp.

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

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 848 of file ticpp.cpp.

                                                              {
  return NextSiblingElement("", throwIfNoSiblings);
}

NextSiblingElement() [2/3]

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

inherited

Definition at line 875 of file ticpp.cpp.

                                                                       {
  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;
}

NextSiblingElement() [3/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 860 of file ticpp.cpp.

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

NoChildren()

bool Node::NoChildren ( ) const

inherited

Check if this node has no children.

Returns

true if this node has no children.

Definition at line 947 of file ticpp.cpp.

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

NodeFactory()

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

protectedinherited

Definition at line 1079 of file ticpp.cpp.

                                                                 {
  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;
}

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.

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

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.

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

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 510 of file ticpp.cpp.

                                             {
  TiXmlNode* parent = GetTiXmlPointer()->Parent();
 
  if ((0 == parent) && throwIfNoParent) {
    TICPPTHROW("No parent exists");
  }
 
  return NodeFactory(parent, false);
}

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 703 of file ticpp.cpp.

                                                        {
  return PreviousSibling("", throwIfNoSiblings);
}

PreviousSibling() [2/3]

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

inherited

Definition at line 731 of file ticpp.cpp.

                                                                           {
  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);
}

PreviousSibling() [3/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 716 of file ticpp.cpp.

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

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 689 of file ticpp.cpp.

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

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 679 of file ticpp.cpp.

                                                          {
  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);
}

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.

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

SetImpRC()

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

inlineprotectedinherited

Definition at line 279 of file ticpp.h.

{ m_impRC = nodeBase->m_tiRC; }

SetTiXmlPointer()

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

inlineprotectedinherited

Definition at line 1283 of file ticpp.h.

                                        {
      m_tiXmlPointer = newPointer;
      SetImpRC(newPointer);
    }

SetValue() [1/2]

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));
    }

References GetTiXmlPointer(), TiXmlNode::SetValue(), and ticpp::Base::ToString().

Here is the call graph for this function:

SetValue() [2/2]

void ticpp::Node::SetValue ( const TiXmlStylesheetReference & 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()

TiXmlStylesheetReference * 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 1000 of file ticpp.cpp.

                               {
  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;
}

ToDeclaration()

Declaration * Node::ToDeclaration ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToDeclaration.

Exceptions

Exception

When this node is not a Declaration.

Definition at line 1014 of file ticpp.cpp.

                                       {
  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;
}

ToDocument()

Document * Node::ToDocument ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToDocument.

Exceptions

Exception

When this node is not a Document.

Definition at line 986 of file ticpp.cpp.

                                 {
  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;
}

ToElement()

Element * Node::ToElement ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToElement.

Exceptions

Exception

When this node is not a Element.

Definition at line 993 of file ticpp.cpp.

                               {
  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;
}

ToString() [1/2]

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

inlineinherited

Definition at line 180 of file ticpp.h.

{ return value; }

ToString() [2/2]

std::string ticpp::Base::ToString ( const TiXmlStylesheetReference & 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();
    }

ToStylesheetReference()

StylesheetReference * Node::ToStylesheetReference ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToStylesheetReference.

Exceptions

Exception

When this node is not a StylesheetReference.

Definition at line 1021 of file ticpp.cpp.

                                                       {
  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;
}

ToText()

Text * Node::ToText ( ) const

inherited

Pointer conversion - replaces TiXmlNode::ToText.

Exceptions

Exception

When this node is not a Text.

Definition at line 1007 of file ticpp.cpp.

                         {
  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;
}

Type()

std::string StylesheetReference::Type

(

)

const

Type.

Will return an empty string if none was found.

Definition at line 909 of file ticpp.cpp.

{ return m_tiXmlPointer->Type(); }

References ticpp::NodeImp< TiXmlStylesheetReference >::m_tiXmlPointer.

ValidatePointer()

void ticpp::Base::ValidatePointer ( ) const

inlineprotectedinherited

Definition at line 281 of file ticpp.h.

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

Value()

std::string Node::Value ( ) const

inherited

Get the value of this node.

Simple wrapper for TiXmlNode::ValueStr.

See also

GetValue

Definition at line 480 of file ticpp.cpp.

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

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::StylesheetReference::StylesheetReference().

m_tiXmlPointer

TiXmlStylesheetReference* ticpp::NodeImp< TiXmlStylesheetReference >::m_tiXmlPointer

protectedinherited

Internal pointer to the TiXml Class which is being wrapped.

Definition at line 1262 of file ticpp.h.

Referenced by ticpp::StylesheetReference::Href(), and ticpp::StylesheetReference::Type().

---

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

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