μHAL (v2.6.5)
Part of the IPbus software repository
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234]
 Nboost
 Cshared_ptr
 NgrammarsThe log_inserter function to add an HttpResponseType object to a log entry
 CNodeTreeParametersGrammarA struct wrapping a set of rules as a grammar that can parse a NodeTreeParametersGrammar of the form "name1=val1;name2=val2;name3=val3"
 CSemicolonDelimitedUriListGrammarThe BOOST::SPIRIT grammar for parsing the Semicolon delimited URI list into a vector of protocol-URI pairs
 Nuhal
 NexceptionA namespace for all exceptions to live in - this will hopefully make documentation a bit clearer
 Ntests
 C_IntegerForward declare an ultra-lightweight wrapper which does formatting of numbers only on demand
 C_Integer< T, IntFmt< bin, fixed, WIDTH > >
 C_Integer< T, IntFmt< bin, variable, WIDTH > >
 C_Integer< T, IntFmt< dec, fixed, WIDTH > >
 C_Integer< T, IntFmt< dec, variable, WIDTH > >
 C_Integer< T, IntFmt< hex, fixed, WIDTH > >
 C_Integer< T, IntFmt< hex, variable, WIDTH > >
 C_Quote
 C_Quote< const char *>
 C_ThisThreadID
 C_TimeForward declaration
 C_Type
 C_ValHeader_A helper struct wrapping an IPbus header and a valid flag
 C_ValVector_A Template helper struct wrapping a block of IPbus header, a register for storing a block of data and a valid flag
 C_ValWord_A Template helper struct wrapping an IPbus header, a register for storing a single word of data, a valid flag and a mask for modifying returned values
 CBaseFunctionObjectAbstract base class for wrapping function pointers, function objects and bound functions as objects
 CBaseLogLevel
 CBuffersA class wrapping the send and recieve buffers that are to be filled and transported and the validated memories associated with them
 CClientFactoryA class to construct an IPbus client based on the protocol identifier specified NOTE! This is a factory method and must be Mutex protected if it is used in multithreaded environments!
 CClientInterfaceAn abstract base class for defining the interface to the various IPbus clients as well as providing the generalized packing functionality
 CConnectionManagerA class to open and manage XML connection files and wrap up the interfaces to the NodeTreeBuilder and the ClientFactory
 CControlHubTransport protocol to transfer an IPbus buffer via ControlHub
 CDebugLevelHelper struct representing the Debug log level to allow us to specialize functions according to their log level
 CDerivedNodeFactoryA singleton class to register derived nodes, and create instances of them later NOTE! This is a factory method and must be Mutex protected if it is used in multithreaded environments!
 CErrorLevelHelper struct representing the Error log level to allow us to specialize functions according to their log level
 CFatalLevelHelper struct representing the Fatal log level to allow us to specialize functions according to their log level
 CFunctionObjectClass for wrapping bound functions and function objects as an object
 CFunctionObject< R, T * >Class for wrapping function pointer as an object
 CHostToTargetInspectorHelper class to decode IPbus packets as passed from the Client to the Target
 CHttpResponseTypeStruct to store an http response received from a server when parsed by boost spirit
 CHwInterfaceA class which bundles a node tree and an IPbus client interface together providing everything you need to navigate and perform hardware access
 CInfoLevelHelper struct representing the Info log level to allow us to specialize functions according to their log level
 CIntFmtEmpty struct which acts as a dummy variable for passing the formatting information around
 CIPbusA class which provides the version-specific functionality for IPbus
 CIPbus< 1, IPbus_minor >A class which provides the version-specific functionality for IPbus
 CIPbus< 2, IPbus_minor >A class which provides the version-specific functionality for IPbus
 CIPbusCoreA class providing the core IPbus packing functionality
 CLocationA class to wrap the function name, filename and line-number location of its construction for the purpose of debugging and tracking unwinding exceptions
 ClogoFun class to print the "Imperial College London" logo one character at a time (A more interesting to show progress than printing dots)
 CMmapTransport protocol to transfer an IPbus buffer via device file, using mmap
 CNodeA heirarchical node for navigating heirarchical firmwares
 CNodeTreeBuilderA class to build a node tree from an Address table file NOTE! This is a factory method and must be Mutex protected if it is used in multithreaded environments!
 CNodeTreeClassAttributeStruct to store the name and member variables within a node class attribute when parsed by boost spirit The class attribute has the form "classname;name1=val1;name2=val2;name3=val3;" where the name-value pairs are optional, as is the trailing semicolon
 CNodeTreeFirmwareInfoAttributeStruct to store the name and member variables within a node endpoint attribute when parsed by boost spirit The endpoint attribute has the form "endpoint;name1=val1;name2=val2;name3=val3;" where the name-value pairs are optional, as is the trailing semicolon
 CNoticeLevelHelper struct representing the Notice log level to allow us to specialize functions according to their log level
 CParserForward declaration of the Parser so we can declare it friend
 CPCIeTransport protocol to transfer an IPbus buffer via PCIe
 CRefWrapper
 CRefWrapper< T *>
 CRegistrationHelperExperimental!! Helper struct for adding the DerivedNode to the Node Factory Declaring an instance of an object at global scope means that it is created before the main code is entered We can use this to our advantage by using the constructor of this object to add entries to the factory in a distributed fashion (for instance, in the file where the derived node is defined), rather than manually having to add entries in one file To make things even simpler, the REGISTER macro expands the template argument to a string and passes it to the constructor
 CRuleRule for matching XML attributes
 CTargetToHostInspectorHelper class to decode IPbus packets as passed from the Target to the Client
 CTCPTransport protocol to transfer an IPbus buffer via TCP
 CTimeFmtA struct whose template parameters represent a time format
 CTimeIntervalStats
 CTranslatedFmt
 CUDPTransport protocol to transfer an IPbus buffer via UDP
 CURIStruct to store a URI when parsed by boost spirit
 CValHeaderA class which wraps a single word of data and marks whether or not it is valid
 CValVectorA class which wraps a block of data and marks whether or not it is valid
 CValWordA class which wraps a single word of data and marks whether or not it is valid
 CWarningLevelHelper struct representing the Warning log level to allow us to specialize functions according to their log level
 Cethernet_frameStruct for storing an ethernet frame
 CGccOutputCleanerParameterized Functor which parses and formats GCC call stack so that they are human readable
 CListWritingVisitor
 CPerfTesterGenerate custom IPbus/uHAL tests from the command line
 CTestStruct