ActiveTextLogger.hpp

Go to the documentation of this file.

// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.

#ifndef ACTIVETEXTLOGGERIMPL_HPP_
#define ACTIVETEXTLOGGERIMPL_HPP_

#include <Svc/ActiveTextLogger/ActiveTextLoggerComponentAc.hpp>
#include <Svc/ActiveTextLogger/LogFile.hpp>
#include <Svc/Types/EventSeverityFilter/EventSeverityFilter.hpp>
#include <config/ActiveTextLoggerCfg.hpp>

namespace Svc {


class ActiveTextLogger final : public ActiveTextLoggerComponentBase {
    friend class ActiveTextLoggerTester;

  public:
    explicit ActiveTextLogger(const char* compName);

    virtual ~ActiveTextLogger();  

    bool set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups = 10);

    void configure(const FwEventIdType* filteredIds, FwSizeType count);

    void setSeverityFilter(Fw::LogSeverity severity, bool enabled);

  private:
    // ----------------------------------------------------------------------
    // Prohibit Copying
    // ----------------------------------------------------------------------

    ActiveTextLogger(const ActiveTextLogger&);

    ActiveTextLogger& operator=(const ActiveTextLogger&);

    // ----------------------------------------------------------------------
    // Constants/Types
    // ----------------------------------------------------------------------

    // ----------------------------------------------------------------------
    // Member Functions
    // ----------------------------------------------------------------------

    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------

    //
    virtual void TextLogger_handler(FwIndexType portNum,             
                                    FwEventIdType id,                
                                    Fw::Time& timeTag,               
                                    const Fw::LogSeverity& severity, 
                                    Fw::TextLogString& text          
    );

    // ----------------------------------------------------------------------
    // Internal interface handlers
    // ----------------------------------------------------------------------

    virtual void TextQueue_internalInterfaceHandler(const Fw::InternalInterfaceString& text 
    );

    // ----------------------------------------------------------------------
    // Member Variables
    // ----------------------------------------------------------------------

    // The optional file to text logs to:
    LogFile m_log_file;

    // Event ID filters
    FwSizeType m_numFilteredIDs;
    FwEventIdType m_filteredIDs[ACTIVE_TEXT_LOGGER_ID_FILTER_SIZE];

    // Severity filter
    EventSeverityFilter m_severityFilter;
};

}  // namespace Svc
#endif /* ACTIVETEXTLOGGERIMPL_HPP_ */