C API (Component Interface)
This event is a request from the system telling a component that it will be expected to log its outputs during the execution period that follows. It should prepare the log, and put in a header if appropriate. A Component receiving this event will also receive EVENT_LOG_TERM; a Data object receiving this event will also receive EVENT_LOG_SERVICE.
Logs can either be "encapsulated" or "unencapsulated". Encapsulated logs must be self-contained in the XML that the component returns to the system whilst servicing EVENT_LOG_TERM. Unencapsulated logs may contain references in that XML to files that the component has written. Unencapsulated logs can, thus, be written faster if there is a large amount of data to log, since the data does not have to be converted to XML and can be written instead as raw binary direct to file. Encapsulated logs, conversely, are neatly packaged in single files, and may be requested by the user for easy archival or distribution. Components need not ever write unencapsulated logs, but they must comply with F_ENCAPSULATED if it is set.
This event is fired once during initialisation, but only on components that are logging.
See the source code for
|This is a documentation page for the BRAHMS Modular Execution (Simulation) Framework. For details of licensing and distribution, please click here. To advise of an error or omission, please click here.|