Introduction The state-of-health (SoH) server is a standard system server that provides SoH data logging services for the control system. Like all system servers, the SoH server is derived from the BaseServer class (see cliserv.h and cliserv.cpp in the code base), and it inherits the inter-process communication framework, standard server messages, etc., that BaseServer provides. For that reason, to achieve a detailed understanding of the SoH server and its client interface library, the reader should rst be thoroughly familiar with the BaseServer and BaseClient classes, which are described in detail in design document DES-0005, The Client/Server Architecture. In the code, the implementation for the SoH server can be found in the le sohServer.cpp. The client interface library for the server is dened and implemented in sohClientLib.h and sohClientLib.cpp. A simple text-based menu client for the server also exists, and it is imple- mented in sohMenu.cpp. The primary documentation for the SoH server source code is the Doxygen-generated HTML documentation associated with each of the above source les. That documentation set is automatically built based on the source code itself. It provides the most detailed, up-to-date descriptions of the code. The document you are reading now is supplemental, and is intended to provide deeper background for the server, and its client API. If contradictions between this document and the Doxygen-generated documentation are found, the Doxygen-generated documentation should be considered correct.
Revised: September 30, 2014 |
Published: March 1, 2013