Tools Library

The Tools library defiles tools used by all the archiver code. More...

Classes
class	CmdArgParser
	General purpose argument parser for command-line programs. More...
class	CmdArg
	Base class for all arguments. More...
class	CmdArgFlag
	Implements a boolean argument. More...
class	CmdArgInt
	Imlpement an integer-typed argument. More...
class	CmdArgDouble
	Implements a double-typed argument. More...
class	CmdArgString
	Implements a string-typed argument. More...
class	ASCIIParser
	Helper class for programming an ASCII-file parser. More...
class	AutoFilePtr
	Auto-close FILE pointer wrapper. More...
class	AutoPtr< T >
	Holds pointer, deletes in destructor. More...
class	AVLItem< Item >
	AVL tree item. More...
class	AVLTree< Item >
	AVL-type balanced tree. More...
class	BenchTimer
	Start/stop type of timer. More...
class	BinaryTreeItem< Item >
	Binary tree item. More...
class	BinaryTree< Item >
	Sorted binary tree for Items that support the "less than" and "equal" operators. More...
class	BitSet
	, .Reasons for reinventing this type of class: More...
class	CGIDemangler
	De-mangle CGI-type input. More...
class	ConcurrentPtrList
	A List that allows concurrent access. More...
class	ConcurrentPtrListIterator
	Iterator for ConcurrentPtrList. More...
class	ConcurrentListIterator< T >
	Type-save wrapper for ConcurrentPtrListIterator. More...
class	ConcurrentList< T >
	Type-save wrapper for ConcurrentPtrList. More...
class	Filename
	Basename, dirname and other file name related helpers. More...
class	FUX
	The f.u.XML helper class. More...
class	GenericException
	Generic Exception: Base class for exceptions. More...
class	epicsMutexGuard
	Automatically takes and releases an epicsMutex. More...
class	Guardable
	Interface for something that can be protected by a Guard. More...
class	Guard
	Automatically takes and releases an epicsMutex. More...
class	GuardRelease
	Temporarily releases and then re-takes a Guard. More...
class	IndexConfig
	The index configuration is used by both the ArchiveIndexTool and the simple file-by-file mechanism supported by the ListedIndex. More...
class	Lockfile
	Lock file. More...
class	MemoryBuffer< T >
	A memory region that can be resized. More...
class	MsgLogger
	A trace or logging facility. More...
class	OrderedMutex
	A mutex with informational name and lock order. More...
class	RegularExpression
	Wrapper for Unix/GNU regex library. More...
class	Throttle
	Timer for throttling messages, thread safe. More...
class	ThrottledMsgLogger
	A throttled MsgLogger. More...

Functions
template<class Item >
int	sort_compare (const Item &a, const Item &b)
	Comparison function used by AVLTree. More...
bool	writeLong (FILE *f, uint32_t value)
	OS-independent binary I/O. More...
bool	readLong (FILE *f, uint32_t *value)
	Read 'value' from file with fixed byte order.
bool	writeShort (FILE *f, uint16_t value)
	Write 'value' to file with fixed byte order.
bool	readShort (FILE *f, uint16_t *value)
	Read 'value' from file with fixed byte order.
bool	writeByte (FILE *f, uint8_t byte)
	Write byte.
bool	readByte (FILE *f, uint8_t *byte)
	Read byte.
void	AVLTree< Item >::make_dotfile (const char *name)
	Generates a graphviz 'dot' file. More...

Detailed Description

The Tools library defiles tools used by all the archiver code.

@{

See ToolsConfig.h for important system-specific configuration options.

Function Documentation

template<class Item >

void AVLTree< Item >::make_dotfile

(

const char *

name

)

Generates a graphviz 'dot' file.

Requires the Item to support const char *toString(const Item &).

template<class Item >

int sort_compare	(	const Item &	a,
		const Item &	b
	)

Comparison function used by AVLTree.

It should return "b-a":

• <0 if a > b
• 0 if a== b
• >0 if a < b

bool writeLong	(	FILE *	f,
		uint32_t	value
	)

OS-independent binary I/O.

All values are written with the most significant byte first, e.g. 0x12345678 is written as 0x12, 0x34, ... 0x78. Write 'value' to file with fixed byte order