ticpp::Base Class Reference

Wrapper around TiXmlBase. More...

#include <ticpp.h>

Inheritance diagram for ticpp::Base:

Collaboration diagram for ticpp::Base:

Public Member Functions
template<class T>
std::string	ToString (const T &value) const
	Converts any class with a proper overload of the << opertor to a std::string.
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.
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.
virtual	~Base ()
	Destructor.

Protected Member Functions
void	SetImpRC (TiXmlBase *nodeBase)
void	ValidatePointer () const
virtual TiXmlBase *	GetBasePointer () const =0

Protected Attributes
TiCppRCImp *	m_impRC
	Holds status of internal TiXmlPointer - use this to determine if object has been deleted already.

Detailed Description

Wrapper around TiXmlBase.

Definition at line 161 of file ticpp.h.

Constructor & Destructor Documentation

~Base()

virtual ticpp::Base::~Base ( )

inlinevirtual

Destructor.

Definition at line 264 of file ticpp.h.

{}

Member Function Documentation

BuildDetailedErrorString()

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

inline

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

References TiXmlDocument::Error(), TiXmlDocument::ErrorCol(), TiXmlDocument::ErrorDesc(), TiXmlDocument::ErrorRow(), GetBasePointer(), TiXmlNode::GetDocument(), and TiXmlNode::Value().

Here is the call graph for this function:

Column()

int ticpp::Base::Column ( ) const

inline

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

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

Here is the call graph for this function:

FromString() [1/2]

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

inline

Specialization for std::string.

Definition at line 201 of file ticpp.h.

                                                                 {
      *out = temp;
    }

FromString() [2/2]

template<class T>

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

inline

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

References TICPPTHROW.

Referenced by ticpp::Attribute::GetName(), ticpp::Attribute::GetValue(), and ticpp::Node::GetValue().

Here is the caller graph for this function:

GetBasePointer()

virtual TiXmlBase * ticpp::Base::GetBasePointer ( ) const

protectedpure virtual

Implemented in ticpp::Attribute, and ticpp::Node.

Referenced by BuildDetailedErrorString(), Column(), operator!=(), operator==(), and Row().

Here is the caller graph for this function:

operator!=()

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

inline

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

References GetBasePointer().

Here is the call graph for this function:

operator==()

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

inline

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

References GetBasePointer().

Here is the call graph for this function:

Row()

int ticpp::Base::Row ( ) const

inline

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

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

Here is the call graph for this function:

SetImpRC()

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

inlineprotected

Definition at line 279 of file ticpp.h.

{ m_impRC = nodeBase->m_tiRC; }

References m_impRC, and TiCppRC::m_tiRC.

Referenced by ticpp::Attribute::SetTiXmlPointer(), and ticpp::NodeImp< T >::SetTiXmlPointer().

Here is the caller graph for this function:

ToString() [1/2]

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

inline

Definition at line 180 of file ticpp.h.

{ return value; }

ToString() [2/2]

template<class T>

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

inline

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

References TICPPTHROW.

Referenced by ticpp::Attribute::SetName(), ticpp::Attribute::SetValue(), and ticpp::Node::SetValue().

Here is the caller graph for this function:

ValidatePointer()

void ticpp::Base::ValidatePointer ( ) const

inlineprotected

Definition at line 281 of file ticpp.h.

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

References m_impRC, and TICPPTHROW.

Referenced by ticpp::Attribute::GetBasePointer(), ticpp::Attribute::GetName(), ticpp::NodeImp< T >::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().

Here is the caller graph for this function:

Member Data Documentation

m_impRC

TiCppRCImp* ticpp::Base::m_impRC

mutableprotected

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::Attribute::Attribute(), ticpp::Attribute::Attribute(), ticpp::Attribute::Attribute(), ticpp::NodeImp< T >::NodeImp(), ticpp::NodeImp< T >::NodeImp(), ticpp::Attribute::~Attribute(), ticpp::NodeImp< T >::~NodeImp(), ticpp::Node::InsertAfterChild(), ticpp::Node::InsertBeforeChild(), ticpp::Node::LinkEndChild(), ticpp::Attribute::operator=(), ticpp::NodeImp< T >::operator=(), ticpp::Node::ReplaceChild(), SetImpRC(), and ValidatePointer().

---

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

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