InputPortBase.hpp

Go to the documentation of this file.

#ifndef FW_INPUT_PORT_BASE_HPP
#define FW_INPUT_PORT_BASE_HPP

#include <Fw/Comp/PassiveComponentBase.hpp>
#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Obj/ObjBase.hpp>
#include <Fw/Port/PortBase.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Fw {

class InputPortBase : public PortBase {
  public:
    void setPortNum(FwIndexType portNum);  // !< set the port number

#if FW_PORT_SERIALIZATION
    virtual SerializeStatus invokeSerial(
        SerializeBufferBase& buffer) = 0;  // !< invoke the port with a serialized version of the call
#endif

  protected:
    InputPortBase();           // Constructor
    virtual ~InputPortBase();  // Destructor
    void init() override;

    PassiveComponentBase* m_comp;  // !< pointer to containing component
    FwIndexType m_portNum;         // !< port number in containing object
#if FW_OBJECT_TO_STRING == 1
    const char* getToStringFormatString() override;  
#endif

  private:
    // Disable constructors since we don't want to instantiate directly
    InputPortBase(InputPortBase*);
    InputPortBase(InputPortBase&);
    InputPortBase& operator=(InputPortBase&);
};

}  // namespace Fw

#endif