LocalGuidance
A library that generates velocity references to follow a path.
Namespaces | Classes | Enumerations | Functions
tinyxml_tools Namespace Reference

Namespaces

 traits
 

Classes

class  DocumentHandle
 
class  DocumentHandleXML
 

Enumerations

enum  DocumentMode { DocumentMode::NONE = -1, DocumentMode::READ = 0, DocumentMode::WRITE = 1, DocumentMode::APPEND = 2 }
 Modes in which document can be handled. More...
 
enum  MergeMode { MergeMode::MERGE = 0, MergeMode::MERGE_OVERWRITE = 1, MergeMode::REPLACE_OVERWRITE = 2 }
 

Functions

TiXmlHandle getChildHandle (const TiXmlHandle &parentHandle, const std::string &childName, bool verbose=true)
 
bool getChildHandle (TiXmlHandle &childHandle, TiXmlHandle parentHandle, std::string childName, bool verbose=true)
 
bool getChildElements (std::vector< TiXmlElement *> &childElements, const TiXmlHandle &parentHandle, const std::string &childName)
 
TiXmlElement * getChildElement (TiXmlElement *parentElement, const std::string &childName)
 
template<typename T , typename U = T, typename = typename std::enable_if<std::is_convertible<U, T>::value>::type>
bool loadParameter (T &parameter, const TiXmlElement *element, const typename traits::element< T >::stringType &attributeName=traits::element< T >::getDefaultName(), const U &defaultValue=traits::element< T >::getDefaultValue())
 
template<typename T , typename U = T, typename = typename std::enable_if<!std::is_const<T>::value && std::is_convertible<U, T>::value>::type>
bool loadParameter (T &parameter, const TiXmlHandle &handle, const typename traits::element< T >::stringType &attributeName=traits::element< T >::getDefaultName(), const U &defaultValue=traits::element< T >::getDefaultValue())
 
template<typename T , typename U = T, typename = typename std::enable_if<!std::is_const<T>::value && std::is_convertible<U, T>::value>::type>
bool loadParameter (const std::string &name, T &parameter, const TiXmlHandle &parentHandle, const typename traits::element< T >::stringType &attributeName=traits::element< T >::getDefaultName(), const U &defaultValue=traits::element< T >::getDefaultValue())
 
template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool loadParameterSiblings (T &parameter, TiXmlElement *element, const typename traits::element< T >::siblingStringType &attributeName=traits::element< typename traits::element< T >::siblingType >::getDefaultName(), const typename traits::element< T >::siblingType &defaultValue=traits::element< typename traits::element< T >::siblingType >::getDefaultValue())
 
template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool loadParameterSiblings (T &parameter, const TiXmlHandle &handle, const typename traits::element< T >::siblingStringType &attributeName=traits::element< typename traits::element< T >::siblingType >::getDefaultName(), const typename traits::element< T >::siblingType &defaultValue=traits::element< typename traits::element< T >::siblingType >::getDefaultValue())
 
template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool loadParameterSiblings (const std::string &name, T &parameter, const TiXmlHandle &parentHandle, const typename traits::element< T >::siblingStringType &attributeName=traits::element< typename traits::element< T >::siblingType >::getDefaultName(), const typename traits::element< T >::siblingType &defaultValue=traits::element< typename traits::element< T >::siblingType >::getDefaultValue())
 
bool createChildElement (TiXmlHandle &childHandle, const TiXmlHandle &parentHandle, std::string childName, bool forceIfExisting=false)
 
TiXmlHandle createChildElement (const TiXmlHandle &parentHandle, std::string childName, bool forceIfExisting=false)
 
template<typename T >
bool writeParameter (const T &parameter, TiXmlHandle handle, const typename traits::element< T >::stringType &attributeName=traits::element< T >::getDefaultName())
 
template<typename T >
bool writeParameter (const std::string &name, const T &parameter, TiXmlHandle parentHandle, const typename traits::element< T >::stringType &attributeName=traits::element< T >::getDefaultName(), const bool forceIfExisting=false)
 
template<typename T >
bool writeParameterSiblings (const std::string &name, const T &parameter, TiXmlHandle parentHandle, const typename traits::element< T >::siblingStringType &attributeName=traits::element< typename traits::element< T >::siblingType >::getDefaultName())
 

Enumeration Type Documentation

◆ DocumentMode

enum tinyxml_tools::DocumentMode
strong

Modes in which document can be handled.

Enumerator
NONE 
READ 
WRITE 
APPEND 

◆ MergeMode

enum tinyxml_tools::MergeMode
strong
Enumerator
MERGE 
MERGE_OVERWRITE 
REPLACE_OVERWRITE 

Function Documentation

◆ createChildElement() [1/2]

bool tinyxml_tools::createChildElement ( TiXmlHandle &  childHandle,
const TiXmlHandle &  parentHandle,
std::string  childName,
bool  forceIfExisting = false 
)

◆ createChildElement() [2/2]

TiXmlHandle tinyxml_tools::createChildElement ( const TiXmlHandle &  parentHandle,
std::string  childName,
bool  forceIfExisting = false 
)

◆ getChildElement()

TiXmlElement* tinyxml_tools::getChildElement ( TiXmlElement *  parentElement,
const std::string &  childName 
)

◆ getChildElements()

bool tinyxml_tools::getChildElements ( std::vector< TiXmlElement *> &  childElements,
const TiXmlHandle &  parentHandle,
const std::string &  childName 
)

◆ getChildHandle() [1/2]

TiXmlHandle tinyxml_tools::getChildHandle ( const TiXmlHandle &  parentHandle,
const std::string &  childName,
bool  verbose = true 
)

◆ getChildHandle() [2/2]

bool tinyxml_tools::getChildHandle ( TiXmlHandle &  childHandle,
TiXmlHandle  parentHandle,
std::string  childName,
bool  verbose = true 
)

◆ loadParameter() [1/3]

template<typename T , typename U = T, typename = typename std::enable_if<std::is_convertible<U, T>::value>::type>
bool tinyxml_tools::loadParameter ( T &  parameter,
const TiXmlElement *  element,
const typename traits::element< T >::stringType &  attributeName = traits::element<T>::getDefaultName(),
const U &  defaultValue = traits::element<T>::getDefaultValue() 
)

◆ loadParameter() [2/3]

template<typename T , typename U = T, typename = typename std::enable_if<!std::is_const<T>::value && std::is_convertible<U, T>::value>::type>
bool tinyxml_tools::loadParameter ( T &  parameter,
const TiXmlHandle &  handle,
const typename traits::element< T >::stringType &  attributeName = traits::element<T>::getDefaultName(),
const U &  defaultValue = traits::element<T>::getDefaultValue() 
)

◆ loadParameter() [3/3]

template<typename T , typename U = T, typename = typename std::enable_if<!std::is_const<T>::value && std::is_convertible<U, T>::value>::type>
bool tinyxml_tools::loadParameter ( const std::string &  name,
T &  parameter,
const TiXmlHandle &  parentHandle,
const typename traits::element< T >::stringType &  attributeName = traits::element<T>::getDefaultName(),
const U &  defaultValue = traits::element<T>::getDefaultValue() 
)

◆ loadParameterSiblings() [1/3]

template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool tinyxml_tools::loadParameterSiblings ( T &  parameter,
TiXmlElement *  element,
const typename traits::element< T >::siblingStringType &  attributeName = traits::element<typename traits::element<T>::siblingType>::getDefaultName(),
const typename traits::element< T >::siblingType &  defaultValue = traits::element<typename traits::element<T>::siblingType>::getDefaultValue() 
)

◆ loadParameterSiblings() [2/3]

template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool tinyxml_tools::loadParameterSiblings ( T &  parameter,
const TiXmlHandle &  handle,
const typename traits::element< T >::siblingStringType &  attributeName = traits::element<typename traits::element<T>::siblingType>::getDefaultName(),
const typename traits::element< T >::siblingType &  defaultValue = traits::element<typename traits::element<T>::siblingType>::getDefaultValue() 
)

◆ loadParameterSiblings() [3/3]

template<typename T , typename = typename std::enable_if<!std::is_const<T>::value>>
bool tinyxml_tools::loadParameterSiblings ( const std::string &  name,
T &  parameter,
const TiXmlHandle &  parentHandle,
const typename traits::element< T >::siblingStringType &  attributeName = traits::element<typename traits::element<T>::siblingType>::getDefaultName(),
const typename traits::element< T >::siblingType &  defaultValue = traits::element<typename traits::element<T>::siblingType>::getDefaultValue() 
)

◆ writeParameter() [1/2]

template<typename T >
bool tinyxml_tools::writeParameter ( const T &  parameter,
TiXmlHandle  handle,
const typename traits::element< T >::stringType &  attributeName = traits::element<T>::getDefaultName() 
)

◆ writeParameter() [2/2]

template<typename T >
bool tinyxml_tools::writeParameter ( const std::string &  name,
const T &  parameter,
TiXmlHandle  parentHandle,
const typename traits::element< T >::stringType &  attributeName = traits::element<T>::getDefaultName(),
const bool  forceIfExisting = false 
)

◆ writeParameterSiblings()

template<typename T >
bool tinyxml_tools::writeParameterSiblings ( const std::string &  name,
const T &  parameter,
TiXmlHandle  parentHandle,
const typename traits::element< T >::siblingStringType &  attributeName = traits::element<typename traits::element<T>::siblingType>::getDefaultName() 
)