ticpp::Attribute Class Reference

Wrapper around TiXmlAttribute. More...

#include <ticpp.h>

Inheritance diagram for ticpp::Attribute:

Collaboration diagram for ticpp::Attribute:

Public Member Functions
	Attribute ()
	Construct an empty attribute.
	Attribute (const std::string &name, const std::string &value)
	Construct an attribute with name and value.
	Attribute (TiXmlAttribute *attribute)
template<class T>
void	GetValue (T *value) const
	Get the value of this attribute Uses Base::FromString to convert TiXmlAttribute::ValueStr from a std::string, and puts it in the passed pointer.
std::string	Value () const
	Get the value of this attribute.
template<class T>
void	SetValue (const T &value)
	Set the value of this node.
template<class T>
void	GetName (T *name) const
	Get the value of this attribute Uses Base::FromString to convert TiXmlAttribute::Name from a std::string, and puts it in the passed pointer.
std::string	Name () const
	Get the value of this attribute.
template<class T>
void	SetName (const T &name)
	Set the value of this attribute.
void	operator= (const Attribute &copy)
	Attribute (const Attribute &copy)
	~Attribute ()
Attribute *	Next (bool throwIfNoAttribute=true) const
	Get the next sibling attribute in the DOM.
Attribute *	Previous (bool throwIfNoAttribute=true) const
	Get the previous sibling attribute in the DOM.
void	IterateNext (const std::string &, Attribute **next) const
void	IteratePrevious (const std::string &, Attribute **previous) const
virtual void	Print (FILE *file, int depth) const
	All TinyXml classes can print themselves to a filestream.
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.

Protected Member Functions
void	SetImpRC (TiXmlBase *nodeBase)
void	ValidatePointer () const

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

Private Member Functions
TiXmlBase *	GetBasePointer () const
void	SetTiXmlPointer (TiXmlAttribute *newPointer)

Private Attributes
TiXmlAttribute *	m_tiXmlPointer

Detailed Description

Wrapper around TiXmlAttribute.

Definition at line 297 of file ticpp.h.

Constructor & Destructor Documentation

Attribute() [1/4]

Attribute::Attribute

(

)

Construct an empty attribute.

Definition at line 75 of file ticpp.cpp.

                     {
  SetTiXmlPointer(new TiXmlAttribute());
  m_impRC->InitRef();
}

References ticpp::Base::m_impRC, and SetTiXmlPointer().

Referenced by Attribute(), IterateNext(), IteratePrevious(), Next(), operator=(), and Previous().

Here is the call graph for this function:

Here is the caller graph for this function:

Attribute() [2/4]

Attribute::Attribute	(	const std::string &	name,
		const std::string &	value )

Construct an attribute with name and value.

Parameters

name	The name of the attribute
value	The value of the attribute

Definition at line 85 of file ticpp.cpp.

                                                                  {
  SetTiXmlPointer(new TiXmlAttribute(name, value));
  m_impRC->InitRef();
}

References ticpp::Base::m_impRC, and SetTiXmlPointer().

Here is the call graph for this function:

Attribute() [3/4]

Attribute::Attribute

(

TiXmlAttribute *

attribute

)

Definition at line 80 of file ticpp.cpp.

                                              {
  SetTiXmlPointer(attribute);
  m_impRC->IncRef();
}

References ticpp::Base::m_impRC, and SetTiXmlPointer().

Here is the call graph for this function:

Attribute() [4/4]

Attribute::Attribute

(

const Attribute &

copy

)

Definition at line 101 of file ticpp.cpp.

    : Base() {
  // Dropping the reference to the old object
  if (m_impRC!=nullptr) m_impRC->DecRef();
 
  // Pointing to the new Object
  SetTiXmlPointer(copy.m_tiXmlPointer);
 
  // The internal tixml pointer changed in the above line
  m_impRC->IncRef();
}

References Attribute(), ticpp::Base::m_impRC, m_tiXmlPointer, and SetTiXmlPointer().

Here is the call graph for this function:

~Attribute()

Attribute::~Attribute

(

)

Definition at line 113 of file ticpp.cpp.

{ m_impRC->DecRef(); }

References ticpp::Base::m_impRC.

Member Function Documentation

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

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

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

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

inlineinherited

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

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

References TICPPTHROW.

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

Here is the caller graph for this function:

GetBasePointer()

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

inlineprivatevirtual

Implements ticpp::Base.

Definition at line 300 of file ticpp.h.

                                           {
      ValidatePointer();
      return m_tiXmlPointer;
    }

References m_tiXmlPointer, and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

GetName()

template<class T>

void ticpp::Attribute::GetName ( T * name ) const

inline

Get the value of this attribute Uses Base::FromString to convert TiXmlAttribute::Name from a std::string, and puts it in the passed pointer.

Parameters

name	[OUT] A pointer to fill with the name

Definition at line 370 of file ticpp.h.

                                {
      ValidatePointer();
      FromString(m_tiXmlPointer->Name(), name);
    }

References ticpp::Base::FromString(), m_tiXmlPointer, and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

GetValue()

template<class T>

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

inline

Get the value of this attribute Uses Base::FromString to convert TiXmlAttribute::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 336 of file ticpp.h.

                                  {
      ValidatePointer();
      FromString(m_tiXmlPointer->ValueStr(), value);
    }

References ticpp::Base::FromString(), m_tiXmlPointer, and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

IterateNext()

void Attribute::IterateNext	(	const std::string &	,
		Attribute **	next ) const

Definition at line 161 of file ticpp.cpp.

                                                                    {
  *next = Next(false);
}

References Attribute(), and Next().

Here is the call graph for this function:

IteratePrevious()

void Attribute::IteratePrevious	(	const std::string &	,
		Attribute **	previous ) const

Definition at line 165 of file ticpp.cpp.

                                                                            {
  *previous = Previous(false);
}

References Attribute(), and Previous().

Here is the call graph for this function:

Name()

std::string Attribute::Name

(

)

const

Get the value of this attribute.

Simple wrapper for TiXmlAttribute::Name.

See also

GetName

Definition at line 120 of file ticpp.cpp.

                                {
  ValidatePointer();
  return m_tiXmlPointer->Name();
}

References m_tiXmlPointer, and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

Next()

Attribute * Attribute::Next

(

bool

throwIfNoAttribute = true

)

const

Get the next sibling attribute in the DOM.

Definition at line 125 of file ticpp.cpp.

                                                        {
  ValidatePointer();
  TiXmlAttribute* attribute = m_tiXmlPointer->Next();
 
  if (0 == attribute) {
    if (throwIfNoAttribute) {
      TICPPTHROW("No more attributes found")
    } else {
      return 0;
    }
  }
 
  Attribute* temp = new Attribute(attribute);
  attribute->m_spawnedWrappers.push_back(temp);
 
  return temp;
}

References Attribute(), TiCppRC::m_spawnedWrappers, m_tiXmlPointer, TICPPTHROW, and ticpp::Base::ValidatePointer().

Referenced by ticpp::Element::IterateFirst(), and IterateNext().

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.

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

References GetBasePointer().

Here is the call graph for this function:

operator=()

void Attribute::operator=

(

const Attribute &

copy

)

Definition at line 90 of file ticpp.cpp.

                                             {
  // Dropping the reference to the old object
  this->m_impRC->DecRef();
 
  // Pointing to the new Object
  SetTiXmlPointer(copy.m_tiXmlPointer);
 
  // The internal tixml pointer changed in the above line
  this->m_impRC->IncRef();
}

References Attribute(), ticpp::Base::m_impRC, m_tiXmlPointer, and SetTiXmlPointer().

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.

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

References GetBasePointer().

Here is the call graph for this function:

Previous()

Attribute * Attribute::Previous

(

bool

throwIfNoAttribute = true

)

const

Get the previous sibling attribute in the DOM.

Definition at line 143 of file ticpp.cpp.

                                                            {
  ValidatePointer();
  TiXmlAttribute* attribute = m_tiXmlPointer->Previous();
 
  if (0 == attribute) {
    if (throwIfNoAttribute) {
      TICPPTHROW("No more attributes found")
    } else {
      return 0;
    }
  }
 
  Attribute* temp = new Attribute(attribute);
  attribute->m_spawnedWrappers.push_back(temp);
 
  return temp;
}

References Attribute(), TiCppRC::m_spawnedWrappers, m_tiXmlPointer, TICPPTHROW, and ticpp::Base::ValidatePointer().

Referenced by IteratePrevious().

Here is the call graph for this function:

Here is the caller graph for this function:

Print()

void Attribute::Print ( FILE * file, int depth ) const

virtual

All TinyXml classes can print themselves to a filestream.

Definition at line 169 of file ticpp.cpp.

                                                 {
  ValidatePointer();
  m_tiXmlPointer->Print(file, depth);
}

References m_tiXmlPointer, and ticpp::Base::ValidatePointer().

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.

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

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

Here is the call graph for this function:

SetImpRC()

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

inlineprotectedinherited

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:

SetName()

template<class T>

void ticpp::Attribute::SetName ( const T & name )

inline

Set the value of this attribute.

Uses Base::ToString to convert name to a std::string, then calls TiXmlAttribute::SetName.

Parameters

name	The name to set

Definition at line 391 of file ticpp.h.

                                {
      ValidatePointer();
      m_tiXmlPointer->SetName(ToString(name));
    }

References m_tiXmlPointer, ticpp::Base::ToString(), and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

SetTiXmlPointer()

void Attribute::SetTiXmlPointer ( TiXmlAttribute * newPointer )

private

Definition at line 174 of file ticpp.cpp.

                                                          {
  m_tiXmlPointer = newPointer;
  SetImpRC(newPointer);
}

References m_tiXmlPointer, and ticpp::Base::SetImpRC().

Referenced by Attribute(), Attribute(), Attribute(), Attribute(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

SetValue()

template<class T>

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

inline

Set the value of this node.

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

Parameters

value

The value to set

Definition at line 357 of file ticpp.h.

                                  {
      ValidatePointer();
      m_tiXmlPointer->SetValue(ToString(value));
    }

References m_tiXmlPointer, ticpp::Base::ToString(), and ticpp::Base::ValidatePointer().

Here is the call graph for this function:

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]

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

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

inlineprotectedinherited

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:

Value()

std::string Attribute::Value

(

)

const

Get the value of this attribute.

Simple wrapper for TiXmlAttribute::ValueStr.

See also

GetValue

Definition at line 115 of file ticpp.cpp.

                                 {
  ValidatePointer();
  return m_tiXmlPointer->ValueStr();
}

References m_tiXmlPointer, and ticpp::Base::ValidatePointer().

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

m_tiXmlPointer

TiXmlAttribute* ticpp::Attribute::m_tiXmlPointer

private

Definition at line 299 of file ticpp.h.

Referenced by Attribute(), GetBasePointer(), GetName(), GetValue(), Name(), Next(), operator=(), Previous(), Print(), SetName(), SetTiXmlPointer(), SetValue(), and Value().

---

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