1 /*
2  * \file       item_printer.h
3  * \brief      OpenCSD :
4  *
5  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
6  */
7 
8 /*
9  * Redistribution and use in source and binary forms, with or without modification,
10  * are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. Neither the name of the copyright holder nor the names of its contributors
20  * may be used to endorse or promote products derived from this software without
21  * specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef ARM_ITEM_PRINTER_H_INCLUDED
36 #define ARM_ITEM_PRINTER_H_INCLUDED
37 
38 #include "opencsd.h"
39 #include <string>
40 
41 class ItemPrinter
42 {
43 public:
44     ItemPrinter();
45     virtual ~ItemPrinter();
46 
47     void setMessageLogger(ocsdMsgLogger *pMsgLogger) { m_pMsgLogger = pMsgLogger; };
48     void itemPrintLine(const std::string &msg);
49 
50     // return wait for the first N packets - test the wait mechanism.
51     void setTestWaits(const int num_waits);
52     const int getTestWaits() const;
53     void decTestWaits();
54 
55 protected:
56     ocsdMsgLogger *m_pMsgLogger;
57     int m_test_waits;
58 };
59 
60 inline ItemPrinter::ItemPrinter() :
61    m_pMsgLogger(0),
62    m_test_waits(0)
63 {
64 }
65 
66 inline ItemPrinter::~ItemPrinter()
67 {
68     m_pMsgLogger = 0;
69 }
70 
71 inline void ItemPrinter::itemPrintLine(const std::string &msg)
72 {
73     if(m_pMsgLogger)
74         m_pMsgLogger->LogMsg(msg);
75 }
76 
77 inline void ItemPrinter::setTestWaits(const int num_waits)
78 {
79     m_test_waits = num_waits;
80 }
81 
82 inline const int ItemPrinter::getTestWaits() const
83 {
84     return m_test_waits;
85 }
86 
87 inline void ItemPrinter::decTestWaits()
88 {
89     m_test_waits--;
90 }
91 
92 #endif // ARM_ITEM_PRINTER_H_INCLUDED
93 
94 /* End of File item_printer.h */
95