LinuxTimerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LinuxTimerComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for LinuxTimer component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef LINUXTIMER_COMP_HPP_
#define LINUXTIMER_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Svc/Cycle/TimerVal.hpp>
#include <Svc/Cycle/CyclePortAc.hpp>
 
namespace Svc {
 
  class LinuxTimerComponentBase :
    public Fw::PassiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class LinuxTimerComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_CycleOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Svc::InputCyclePort *port 
    );
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_CycleOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    LinuxTimerComponentBase(
        const char* compName 
    );
#else
    LinuxTimerComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~LinuxTimerComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Invocation functions for typed output ports
    // ----------------------------------------------------------------------
 
    void CycleOut_out(
        NATIVE_INT_TYPE portNum, 
        Svc::TimerVal &cycleStart 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_CycleOut_OutputPorts(void);
 
 
    enum {
       NUM_CYCLEOUT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_CycleOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Svc::OutputCyclePort m_CycleOut_OutputPort[NUM_CYCLEOUT_OUTPUT_PORTS];
 
 
 
  };
 
} // end namespace Svc
#endif