argos_configuration.h File Reference

#include <argos3/core/utility/datatypes/datatypes.h>
#include <argos3/core/utility/configuration/argos_exception.h>
#include <argos3/core/utility/configuration/tinyxml/ticpp.h>
#include <string>

Include dependency graph for argos_configuration.h:

Go to the source code of this file.

Namespaces
namespace	argos
	The namespace containing all the ARGoS related code.

Typedefs
typedef ticpp::Element	argos::TConfigurationNode
	The ARGoS configuration XML node.
typedef ticpp::Iterator< ticpp::Element >	argos::TConfigurationNodeIterator
	The iterator for the ARGoS configuration XML node.
typedef ticpp::Iterator< ticpp::Attribute >	argos::TConfigurationAttributeIterator
	The iterator for the attributes of an XML node.

Functions
bool	argos::NodeExists (TConfigurationNode &t_node, const std::string &str_tag) throw ()
	Given a tree root node, returns true if one of its child nodes has the wanted name.
TConfigurationNode &	argos::GetNode (TConfigurationNode &t_node, const std::string &str_tag)
	Given a tree root node, returns the first of its child nodes with the wanted name.
void	argos::AddChildNode (TConfigurationNode &t_parent_node, TConfigurationNode &t_child_node)
	Adds an XML node as child of another XML node.
template<typename T >
void	argos::GetNodeText (TConfigurationNode &t_node, T &t_buffer)
	Returns the text of the passed XML node A node text is as follows:
template<typename T >
void	argos::GetNodeTextOrDefault (TConfigurationNode &t_node, T &t_buffer, const T &t_default)
	Returns the text of the passed XML node, or the passed default value.
bool	argos::NodeAttributeExists (TConfigurationNode &t_node, const std::string &str_attribute)
	Returns true if the specified attribute of a node exists.
template<typename T >
void	argos::GetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, T &t_buffer)
	Returns the value of a node's attribute.
void	argos::GetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, bool &b_buffer)
	Returns the value of a node's attribute.
void	argos::GetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, UInt8 &un_buffer)
	Returns the value of a node's attribute.
void	argos::GetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, SInt8 &n_buffer)
	Returns the value of a node's attribute.
template<typename T >
void	argos::GetNodeAttributeOrDefault (TConfigurationNode &t_node, const std::string &str_attribute, T &t_buffer, const T &t_default)
	Returns the value of a node's attribute, or the passed default value.
void	argos::GetNodeAttributeOrDefault (TConfigurationNode &t_node, const std::string &str_attribute, bool &b_buffer, const bool b_default)
	Returns the value of a node's attribute, or the passed default value.
void	argos::GetNodeAttributeOrDefault (TConfigurationNode &t_node, const std::string &str_attribute, UInt8 &un_buffer, const UInt8 un_default)
	Returns the value of a node's attribute, or the passed default value.
void	argos::GetNodeAttributeOrDefault (TConfigurationNode &t_node, const std::string &str_attribute, SInt8 &n_buffer, const SInt8 n_default)
	Returns the value of a node's attribute, or the passed default value.
template<typename T >
void	argos::SetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, const T &t_value)
	Sets the value of the wanted node's attribute.
void	argos::SetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, const bool b_value)
	Sets the value of the wanted node's attribute.
void	argos::SetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, const SInt8 n_value)
	Sets the value of the wanted node's attribute.
void	argos::SetNodeAttribute (TConfigurationNode &t_node, const std::string &str_attribute, const UInt8 un_value)
	Sets the value of the wanted node's attribute.