ocsd_dcd_tree_elem.h
Go to the documentation of this file.
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
#define ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
#include "common/ocsd_dcd_mngr_i.h"
#include "common/trc_component.h"
typedef struct _decoder_elements
{
std::string dcd_name;
TraceComponent *dcd_handle;
IDecoderMngr *dcd_mngr;
ocsd_trace_protocol_t protocol;
bool created;
} decoder_element;
class DecodeTreeElement : protected decoder_element
{
public:
DecodeTreeElement();
~DecodeTreeElement() {};
void SetDecoderElement(const std::string &name, IDecoderMngr *dcdMngr, TraceComponent *pHandle, bool bCreated);
void DestroyElem();
const std::string &getDecoderTypeName() { return dcd_name; };
IDecoderMngr *getDecoderMngr() { return dcd_mngr; };
ocsd_trace_protocol_t getProtocol() const { return protocol; };
TraceComponent *getDecoderHandle() { return dcd_handle; };
};
inline DecodeTreeElement::DecodeTreeElement()
{
dcd_name = "unknown";
dcd_mngr = 0;
dcd_handle = 0;
protocol = OCSD_PROTOCOL_END;
created = false;
}
inline void DecodeTreeElement::SetDecoderElement(const std::string &name, IDecoderMngr *dcdMngr, TraceComponent *pHandle, bool bCreated)
{
dcd_name = name;
dcd_mngr = dcdMngr;
dcd_handle = pHandle;
protocol = OCSD_PROTOCOL_UNKNOWN;
if(dcd_mngr)
protocol = dcd_mngr->getProtocolType();
created = bCreated;
}
inline void DecodeTreeElement::DestroyElem()
{
if(created && (dcd_mngr != 0) && (dcd_handle != 0))
dcd_mngr->destroyDecoder(dcd_handle);
}
#endif // ARM_OCSD_DCD_TREE_ELEM_H_INCLUDED
/* End of File ocsd_dcd_tree_elem.h */
DecodeTreeElement
Decode tree element.
Definition: ocsd_dcd_tree_elem.h:69
DecodeTreeElement::getProtocol
ocsd_trace_protocol_t getProtocol() const
Definition: ocsd_dcd_tree_elem.h:79
DecodeTreeElement::getDecoderTypeName
const std::string & getDecoderTypeName()
Definition: ocsd_dcd_tree_elem.h:77
DecodeTreeElement::getDecoderMngr
IDecoderMngr * getDecoderMngr()
Definition: ocsd_dcd_tree_elem.h:78
DecodeTreeElement::getDecoderHandle
TraceComponent * getDecoderHandle()
Definition: ocsd_dcd_tree_elem.h:80
DecodeTreeElement::~DecodeTreeElement
~DecodeTreeElement()
Definition: ocsd_dcd_tree_elem.h:72
IDecoderMngr
Definition: ocsd_dcd_mngr_i.h:50
IDecoderMngr::getProtocolType
virtual const ocsd_trace_protocol_t getProtocolType() const =0
Get the built in protocol type ID managed by this instance - extern for custom decoders.
IDecoderMngr::destroyDecoder
virtual ocsd_err_t destroyDecoder(TraceComponent *pComponent)=0
TraceComponent
Base class for all decode components in the library.
Definition: trc_component.h:57
DecodeTreeElement::DestroyElem
void DestroyElem()
Definition: ocsd_dcd_tree_elem.h:103
DecodeTreeElement::SetDecoderElement
void SetDecoderElement(const std::string &name, IDecoderMngr *dcdMngr, TraceComponent *pHandle, bool bCreated)
Definition: ocsd_dcd_tree_elem.h:92
decoder_element
struct _decoder_elements decoder_element
DecodeTreeElement::DecodeTreeElement
DecodeTreeElement()
Definition: ocsd_dcd_tree_elem.h:83
ocsd_trace_protocol_t
enum _ocsd_trace_protocol_t ocsd_trace_protocol_t
OCSD_PROTOCOL_UNKNOWN
@ OCSD_PROTOCOL_UNKNOWN
Definition: ocsd_if_types.h:559
OCSD_PROTOCOL_END
@ OCSD_PROTOCOL_END
Definition: ocsd_if_types.h:584
ocsd_dcd_mngr_i.h
_decoder_elements
Decode tree element base structure.
Definition: ocsd_dcd_tree_elem.h:51
_decoder_elements::dcd_mngr
IDecoderMngr * dcd_mngr
pointer to the decoder manager interface for the decodcer
Definition: ocsd_dcd_tree_elem.h:54
_decoder_elements::dcd_handle
TraceComponent * dcd_handle
handle to the decoder object
Definition: ocsd_dcd_tree_elem.h:53
_decoder_elements::protocol
ocsd_trace_protocol_t protocol
protocol type
Definition: ocsd_dcd_tree_elem.h:55
_decoder_elements::created
bool created
Definition: ocsd_dcd_tree_elem.h:56
_decoder_elements::dcd_name
std::string dcd_name
Registered name of the decoder.
Definition: ocsd_dcd_tree_elem.h:52
trc_component.h
OpenCSD : Base trace decode component.