event/log/LogRecord.h

/** @file
 * $Source: /home/cvsmanager/yoda/event/log/LogRecord.h,v $
 * $Id: LogRecord.h,v 4.0 2005/03/06 04:33:01 kusanagi Exp $
 * $Author: kusanagi $
 * 
 * Header file for the LogRecord class.
 */
#ifndef LOG_RECORD_H
#define LOG_RECORD_H

#include "event/SubPacket.h"
namespace pamela {
  /**
   * LogRecord data Wrapper
   *
   * Each pamela::LogRecord represents a PAMELA CPU software?s error or other software conditions.
   * The pair (FILE_ID,LINE) identifies a unique error/log trace that can be found in all source code:
   * this gives the maximum of the information with the minimum of size
   * (this information also goes in part to the history area).
   */
  class LogRecord: public TObject {
  private:
    
  public:
    /**
     * The On-Board-Time of the Record.
     */
    UINT32  RECORD_OBT;

    /**
     * The Type of the Record.
     *
     * BITMASK description:            <BR>
     * #define LU_WARNING       (1<<0) <BR>
     * #define LU_CRITICAL      (1<<1) <BR>
     * #define LU_INTERNAL      (1<<2) <BR>
     * #define LU_FATAL         (1<<3) <BR>
     * #define LU_NORMAL_TRACE  (1<<4) <BR>
     * #define LU_DEBUG_TRACE   (1<<5) <BR>
     * #define LU_ALARM         (1<<6) <BR>
     * #define LU_HA            (1<<7) <BR>
     * <B> The first seven bits are mutually esclusive. </B>
     * Bit 8 indicates if this log is also recorded in the history area.
     */
    UINT8   MASKTYPE;

    /**
     * The FileId of the record.
     * Identification code of a specific PAMELA CPU software ".c" file in which this error/log trace occurred. 
     * Each source file is identified by a unique number in the range [0,255].
     */
    UINT8   FILE_ID;

    /**
     * The Line_No of te record.
     * Identify the line number inside the file code referred by the FILE_ID parameter.
     */
    UINT16  LINE_NO;

    /**
     * Supplementary field which depends on the related log trace.
     */
    UINT32  INFO1;
        
    LogRecord(void);
    ~LogRecord(void){};
    ClassDef(LogRecord, 1)
  };
}

#endif /* LOG_RECORD_H */

1	kusanagi	1.1	/** @file
2	kusanagi	1.2	* $Source: /home/cvsmanager/yoda/event/log/LogRecord.h,v $
3	kusanagi	4.1	* $Id: LogRecord.h,v 4.0 2005/03/06 04:33:01 kusanagi Exp $
4	kusanagi	1.2	* $Author: kusanagi $
5	kusanagi	1.1	*
6			* Header file for the LogRecord class.
7			*/
8			#ifndef LOG_RECORD_H
9			#define LOG_RECORD_H
10	kusanagi	1.2
11	kusanagi	2.2	#include "event/SubPacket.h"
12	kusanagi	1.1	namespace pamela {
13			/**
14	kusanagi	4.1	* LogRecord data Wrapper
15			*
16			* Each pamela::LogRecord represents a PAMELA CPU software?s error or other software conditions.
17			* The pair (FILE_ID,LINE) identifies a unique error/log trace that can be found in all source code:
18			* this gives the maximum of the information with the minimum of size
19			* (this information also goes in part to the history area).
20	kusanagi	1.1	*/
21			class LogRecord: public TObject {
22			private:
23
24			public:
25			/**
26	kusanagi	4.1	* The On-Board-Time of the Record.
27			*/
28	kusanagi	1.3	UINT32 RECORD_OBT;
29	kusanagi	4.1
30			/**
31			* The Type of the Record.
32			*
33			* BITMASK description: <BR>
34			* #define LU_WARNING (1<<0) <BR>
35			* #define LU_CRITICAL (1<<1) <BR>
36			* #define LU_INTERNAL (1<<2) <BR>
37			* #define LU_FATAL (1<<3) <BR>
38			* #define LU_NORMAL_TRACE (1<<4) <BR>
39			* #define LU_DEBUG_TRACE (1<<5) <BR>
40			* #define LU_ALARM (1<<6) <BR>
41			* #define LU_HA (1<<7) <BR>
42			* <B> The first seven bits are mutually esclusive. </B>
43			* Bit 8 indicates if this log is also recorded in the history area.
44			*/
45	kusanagi	1.3	UINT8 MASKTYPE;
46	kusanagi	4.1
47			/**
48			* The FileId of the record.
49			* Identification code of a specific PAMELA CPU software ".c" file in which this error/log trace occurred.
50			* Each source file is identified by a unique number in the range [0,255].
51			*/
52	kusanagi	1.3	UINT8 FILE_ID;
53	kusanagi	4.1
54			/**
55			* The Line_No of te record.
56			* Identify the line number inside the file code referred by the FILE_ID parameter.
57			*/
58	kusanagi	1.3	UINT16 LINE_NO;
59	kusanagi	4.1
60			/**
61			* Supplementary field which depends on the related log trace.
62			*/
63	kusanagi	1.3	UINT32 INFO1;
64	kusanagi	1.1
65			LogRecord(void);
66			~LogRecord(void){};
67			ClassDef(LogRecord, 1)
68			};
69			}
70
71			#endif /* LOG_RECORD_H */
72