uhal::ConnectionManager::ConnectionDescriptor Struct Reference

A struct to hold the fields of each entry in the XML connections file. More...

#include <uhal/ConnectionManager.hpp>

Public Member Functions
	ConnectionDescriptor (const pugi::xml_node &aNode, const boost::filesystem::path &aConnectionFile, bool &aSuccess)
	Constructor. More...
bool	operator== (const ConnectionDescriptor &aConnectionDescriptor) const
	Comparison operation. More...

Public Attributes
std::string	id
	An identifier for an individual. More...
std::string	uri
	The full uri for making the connection. More...
std::string	address_table
	The address table for building the node tree. More...
boost::filesystem::path	connection_file
	The connection file which provided this entry. More...

Detailed Description

A struct to hold the fields of each entry in the XML connections file.

Definition at line 82 of file ConnectionManager.hpp.

Constructor & Destructor Documentation

ConnectionDescriptor()

uhal::ConnectionManager::ConnectionDescriptor::ConnectionDescriptor	(	const pugi::xml_node &	aNode,
		const boost::filesystem::path &	aConnectionFile,
		bool &	aSuccess
	)

Constructor.

Parameters

aNode	a PugiXML node from which to extract the details of the connection
aConnectionFile	the connection file which this entry is contained in
aSuccess	return whether all the necessary values were extracted from the PugiXML node

Definition at line 59 of file ConnectionManager.cpp.

References address_table, uhal::utilities::GetXMLattribute< true >(), and uri.

Member Function Documentation

operator==()

bool uhal::ConnectionManager::ConnectionDescriptor::operator==

(

const ConnectionDescriptor &

aConnectionDescriptor

)

const

Comparison operation.

Parameters

aConnectionDescriptor

another ConnectionDescriptor to compare with

Returns

whether the two ConnectionDescriptors are identical

Definition at line 83 of file ConnectionManager.cpp.

References address_table, id, uhal::tests::uri, and uri.

Member Data Documentation

address_table

std::string uhal::ConnectionManager::ConnectionDescriptor::address_table

The address table for building the node tree.

Definition at line 104 of file ConnectionManager.hpp.

Referenced by uhal::ConnectionManager::CallBack(), ConnectionDescriptor(), and operator==().

connection_file

boost::filesystem::path uhal::ConnectionManager::ConnectionDescriptor::connection_file

The connection file which provided this entry.

Definition at line 106 of file ConnectionManager.hpp.

id

std::string uhal::ConnectionManager::ConnectionDescriptor::id

An identifier for an individual.

Definition at line 100 of file ConnectionManager.hpp.

Referenced by uhal::ConnectionManager::CallBack(), and operator==().

uri

std::string uhal::ConnectionManager::ConnectionDescriptor::uri

The full uri for making the connection.

Definition at line 102 of file ConnectionManager.hpp.

Referenced by uhal::ConnectionManager::CallBack(), ConnectionDescriptor(), and operator==().

---

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

• uhal/include/uhal/ConnectionManager.hpp
• uhal/src/common/ConnectionManager.cpp