Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
NET::AddressRepresents an IP address and port
AutoDelete< T >Automatically free a single object when this loses scope
AutoDeleteArray< T >Automatically free an array of objects when this loses scope
MPMA::BlockingObjectAn object that can be used to block a thread until another thread signals it to resume
MPMA::DirectoryRepresents a directory that can be browsed and navigated
MPMA::FilenameConstruct this with a non-absolute filename using either windows or linux style, to generate a filename for whatever platform this is running on. Filenames that begin with ~ are relative to the users home directory
GFX::GraphicsSetupRepresents the state of graphics system and its related window. Everything in here can be both changed or read from
MPMA::InitAndShutdownYou MUST declare this (and only 1 of it) at the start of the scope in which you want the framework to be used. It will handle all setup and cleanup required. Most likely you want to do this at the start of main()
GEO::Matrix2A 2x2 matrix
GEO::Matrix3A 3x3 matrix
GEO::Matrix4A 4x4 matrix
GEO::MatrixN< rowCount >Base type of all square matrices (row-based)
INPUT::MOUSE::MousePixelPositionIn absolute mode, this represents the location of the mouse cursor, measured in pixels from the origin, which is the lower left corner of the window. In relative mode this represents the number of pixels the mouse moved in each direction since the last frame
INPUT::MOUSE::MouseScaledPositionRepresents the location of the mouse cursor, measured from the origin, which is the lower left corner of the window. Both X and Y are a number between 0 and 1. This is only used in absolute mode
MPMAMemoryManagerSingleton (mpmaMemoryManager). Do not instantiate this yourself. The memory manager
MPMA::MutexLockMutex (re-entrant safe)
MPMA::RouterInputThe program will send it's debug data to instances of this. This will take data and marshell it to all attached outputs
MPMA::RouterOutputImplementations of this are output targets which can accept debug data from a RouterInput and output it to anything it likes
MPMA::RouterOutputFileA simple RouterInputOutput implementation that writes output to a file (overridding the file)
MPMA::RouterOutputStdoutA simple RouterInputOutput implementation that writes output to a stdout
MPMA::RWSleepLockReaderWriter sleep-lock (re-entrant safe). Read locks don't block each other out, but Write locks are exclusive to all other locks
GFX::ScreenSizeRepresents a the size of a window or screen
MPMA::SpinLockSpinlock (NOT re-entrant safe) that reverts to a sleeplock on single cpu systems. If no lock-contention occurs, these is extremely little overhead in use
MPMA::SystemInfoInformation about the system. These are readable anytime after init. Values which are not possible to obtain will be populated with sane defaults
MPMA::TakeMutexLockUsed to lock/unlock a MutexLock automatically using scope. The lock is released on dustruction
MPMA::TakeRWSleepLockUsed to lock/unlock a RWSleepLock automatically using scope. The lock is released on dustruction
MPMA::TakeSpinLockUsed to lock/unlock a spinlock automatically using scope. The lock is released on destruction
NET::TCPClientRepresents a stream-based reliable connection to another PC
NET::TCPServerListens for new connections and spawns a TCPClient to recieve them
MPMA::ThreadRepresents a thread
MPMA::ThreadParamA user-defined parameter passed to the thread procedure
MPMA::ThreadPoolA pool of pre-created threads
MPMA::TimerA timer
NET::UDPClientUsed to send udp packets
INPUT::UnifiedButtonRepresents an input button from an arbitrary device
MPMA::VaryA variable that can have eithar an integral, real, or string type. It can convert itself between the different types
GEO::Vector2A 2d vector or point
GEO::Vector3A 3d vector or point
GEO::Vector4A 4d vector or point
GEO::VectorN< elemCount >Base type of all vectors

Generated on Sat Aug 9 15:05:08 2008 for MPMA Framework by  doxygen 1.5.6