uhal::detail Namespace Reference

Classes
class	PacketFmt
	Class used to display IPbus packet contents in human-readable format (e.g. in log messages) More...
class	RobustSessionMutex
	Exception class to handle errors from pthread mutex-related functions. More...
class	SharedObject
	Wrapper for C++ object that's placed in shared memory. More...

Typedefs
typedef std::unique_lock< RobustSessionMutex >	ScopedSessionLock

Functions
std::string	getAddressDescription (const ClientInterface &aClient, const uint32_t aAddress, const size_t &aMaxListSize)
	Generates a short string summarising which nodes match the specified address. More...
std::ostream &	operator<< (std::ostream &, const PacketFmt &)
std::string	getAddressDescription (const Node &aNode, const uint32_t aAddress, const size_t &aMaxListSize)
	Generates a short string summarising which nodes match the specified address. More...
bool	compareNodeAddr (const Node *aNodeL, const Node *aNodeR)
std::vector< std::pair< const Node *, const Node * > >	getAddressOverlaps (const Node &aNode)
void	printNodeOverlapDescription (std::ostream &aStream, const Node &aNode1, const Node &aNode2)
bool	writeNodeOverlapReport (const std::string &aFilePath, const std::vector< std::pair< const Node *, const Node * > > &aNodes, const std::string &aHeader)

Typedef Documentation

ScopedSessionLock

typedef std::unique_lock<RobustSessionMutex> uhal::detail::ScopedSessionLock

Definition at line 53 of file RobustSessionMutex.hpp.

Function Documentation

compareNodeAddr()

bool uhal::detail::compareNodeAddr	(	const Node *	aNodeL,
		const Node *	aNodeR
	)

Definition at line 114 of file utilities.cpp.

References uhal::Node::getAddress().

Referenced by uhal::NodeTreeBuilder::calculateHierarchicalAddresses(), and getAddressOverlaps().

getAddressDescription() [1/2]

std::string uhal::detail::getAddressDescription	(	const ClientInterface &	aClient,
		const uint32_t	aAddress,
		const size_t &	aMaxListSize
	)

Generates a short string summarising which nodes match the specified address.

Definition at line 105 of file utilities.cpp.

References getAddressDescription(), and uhal::ClientInterface::mNode.

Referenced by uhal::tests::BOOST_FIXTURE_TEST_CASE(), getAddressDescription(), and uhal::exception::IPbusCoreResponseCodeSet::IPbusCoreResponseCodeSet().

getAddressDescription() [2/2]

std::string uhal::detail::getAddressDescription	(	const Node &	aNode,
		const uint32_t	aAddress,
		const size_t &	aMaxListSize
	)

Generates a short string summarising which nodes match the specified address.

Definition at line 46 of file utilities.cpp.

References uhal::Node::begin(), uhal::Node::end(), uhal::Node::getLineage(), uhal::Node::getPath(), uhal::defs::HIERARCHICAL, and uhal::defs::INCREMENTAL.

getAddressOverlaps()

std::vector< std::pair< const Node *, const Node * > > uhal::detail::getAddressOverlaps

(

const Node &

aNode

)

Definition at line 120 of file utilities.cpp.

References uhal::Node::begin(), compareNodeAddr(), uhal::Node::getAddress(), uhal::Node::getMask(), uhal::Node::getMode(), uhal::Node::getSize(), uhal::defs::HIERARCHICAL, uhal::defs::INCREMENTAL, uhal::Node::isChildOf(), uhal::Node::const_iterator::next(), uhal::defs::NOMASK, and uhal::defs::SINGLE.

Referenced by uhal::tests::BOOST_FIXTURE_TEST_CASE(), and uhal::NodeTreeBuilder::checkForAddressCollisions().

operator<<()

std::ostream & uhal::detail::operator<<	(	std::ostream &	aStream,
		const PacketFmt &	aPacket
	)

Definition at line 26 of file PacketFmt.cpp.

References uhal::detail::PacketFmt::mData.

printNodeOverlapDescription()

void uhal::detail::printNodeOverlapDescription	(	std::ostream &	aStream,
		const Node &	aNode1,
		const Node &	aNode2
	)

Definition at line 169 of file utilities.cpp.

References uhal::Node::getAddress(), uhal::Node::getMask(), uhal::Node::getMode(), uhal::Node::getPath(), uhal::Node::getSize(), and uhal::defs::INCREMENTAL.

Referenced by writeNodeOverlapReport().

writeNodeOverlapReport()

bool uhal::detail::writeNodeOverlapReport	(	const std::string &	aFilePath,
		const std::vector< std::pair< const Node *, const Node * > > &	aNodes,
		const std::string &	aHeader
	)

Definition at line 197 of file utilities.cpp.

References printNodeOverlapDescription().

Referenced by uhal::NodeTreeBuilder::checkForAddressCollisions().