OpenCSD - CoreSight Trace Decode Library  1.3.3
trc_component.h
Go to the documentation of this file.
1 
9 /*
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of the copyright holder nor the names of its contributors
21  * may be used to endorse or promote products derived from this software without
22  * specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
28  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef ARM_TRC_COMPONENT_H_INCLUDED
37 #define ARM_TRC_COMPONENT_H_INCLUDED
38 
39 #include <string>
40 #include "comp_attach_pt_t.h"
42 #include "ocsd_error.h"
43 
44 class errLogAttachMonitor;
45 
57 {
58 public:
59  TraceComponent(const std::string &name);
60  TraceComponent(const std::string &name, int instIDNum);
61  virtual ~TraceComponent();
63  const std::string &getComponentName() const { return m_name; };
64  void setComponentName(const std::string &name) { m_name = name; };
65 
68 
79  ocsd_err_t setComponentOpMode(uint32_t op_flags);
80 
86  const uint32_t getComponentOpMode() const { return m_op_flags; };
87 
95  const uint32_t getSupportedOpModes() const { return m_supported_op_flags; };
96 
103  void setAssocComponent(TraceComponent *assocComp) { m_assocComp = assocComp; };
104 
105 
111  TraceComponent *getAssocComponent() { return m_assocComp; };
112 
116  void LogDefMessage(const std::string &msg)
117  {
118  LogMessage(m_errVerbosity, msg);
119  }
120 
121 protected:
122  friend class errLogAttachMonitor;
123 
124  void LogError(const ocsdError &Error);
125  void LogMessage(const ocsd_err_severity_t filter_level, const std::string &msg);
126  const ocsd_err_severity_t getErrorLogLevel() const { return m_errVerbosity; };
127  const bool isLoggingErrorLevel(const ocsd_err_severity_t level) const { return level <= m_errVerbosity; };
129 
130  void do_attach_notify(const int num_attached);
131  void Init(const std::string &name);
132 
133  uint32_t m_op_flags;
135 
136 private:
137  componentAttachPt<ITraceErrorLog> m_error_logger;
138  ocsd_hndl_err_log_t m_errLogHandle;
139  ocsd_err_severity_t m_errVerbosity;
140  errLogAttachMonitor *m_pErrAttachMon;
141 
142  std::string m_name;
143 
144  TraceComponent *m_assocComp;
145 };
147 #endif // ARM_TRC_COMPONENT_H_INCLUDED
148 
149 /* End of File trc_component.h */
Base class for all decode components in the library.
Definition: trc_component.h:57
const uint32_t getComponentOpMode() const
Definition: trc_component.h:86
virtual ~TraceComponent()
componentAttachPt< ITraceErrorLog > * getErrorLogAttachPt()
Definition: trc_component.h:67
uint32_t m_supported_op_flags
supported component operational mode flags - derived class to intialise.
uint32_t m_op_flags
current component operational mode flags.
void setComponentName(const std::string &name)
Definition: trc_component.h:64
TraceComponent * getAssocComponent()
ocsd_err_t setComponentOpMode(uint32_t op_flags)
const ocsd_err_severity_t getErrorLogLevel() const
void updateErrorLogLevel()
const bool isLoggingErrorLevel(const ocsd_err_severity_t level) const
TraceComponent(const std::string &name)
void setAssocComponent(TraceComponent *assocComp)
void Init(const std::string &name)
void LogMessage(const ocsd_err_severity_t filter_level, const std::string &msg)
void LogError(const ocsdError &Error)
const std::string & getComponentName() const
Definition: trc_component.h:63
void do_attach_notify(const int num_attached)
const uint32_t getSupportedOpModes() const
Definition: trc_component.h:95
TraceComponent(const std::string &name, int instIDNum)
void LogDefMessage(const std::string &msg)
friend class errLogAttachMonitor
OpenCSD : Component attachment point interface class.
unsigned int ocsd_hndl_err_log_t
enum _ocsd_err_severity_t ocsd_err_severity_t
enum _ocsd_err_t ocsd_err_t
OpenCSD : Library Error class.