F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
BufferRepeater.hpp
Go to the documentation of this file.
1
// ======================================================================
2
// \title BufferRepeater.hpp
3
// \author lestarch
4
// \brief hpp file for GenericRepeater component implementation class
5
//
6
// \copyright
7
// Copyright 2009-2015, by the California Institute of Technology.
8
// ALL RIGHTS RESERVED. United States Government Sponsorship
9
// acknowledged.
10
//
11
// ======================================================================
12
13
#ifndef BufferRepeater_HPP
14
#define BufferRepeater_HPP
15
16
#include "
Svc/BufferRepeater/BufferRepeaterComponentAc.hpp
"
17
18
namespace
Svc
{
19
20
class
BufferRepeater
:
public
BufferRepeaterComponentBase
{
21
public
:
25
enum
BufferRepeaterFailureOption
{
26
NO_RESPONSE_ON_OUT_OF_MEMORY
,
27
WARNING_ON_OUT_OF_MEMORY
,
28
FATAL_ON_OUT_OF_MEMORY
,
29
NUM_BUFFER_REPEATER_FAILURE_OPTIONS
30
};
31
// ----------------------------------------------------------------------
32
// Construction, initialization, and destruction
33
// ----------------------------------------------------------------------
34
37
BufferRepeater
(
const
char
*
const
compName
38
);
39
42
void
init
(
const
NATIVE_INT_TYPE
instance = 0
43
);
44
47
~BufferRepeater
();
48
53
void
configure
(
BufferRepeaterFailureOption
allocation_failure_response);
54
55
private
:
56
// ----------------------------------------------------------------------
57
// Helper functions
58
// ----------------------------------------------------------------------
59
67
bool
check_allocation(
FwIndexType
index,
const
Fw::Buffer
& new_allocation,
const
Fw::Buffer
& incoming_buffer);
68
69
private
:
70
// ----------------------------------------------------------------------
71
// Handler implementations for user-defined serial input ports
72
// ----------------------------------------------------------------------
73
76
void
portIn_handler(
NATIVE_INT_TYPE
portNum,
77
Fw::Buffer
& Buffer
78
);
79
80
BufferRepeaterFailureOption
m_allocation_failure_response;
81
};
82
83
}
// end namespace Svc
84
85
#endif
NATIVE_INT_TYPE
PlatformIntType NATIVE_INT_TYPE
Definition
BasicTypes.h:51
BufferRepeaterComponentAc.hpp
FwIndexType
PlatformIndexType FwIndexType
Definition
FpConfig.h:15
Fw::Buffer
Definition
Buffer.hpp:43
Fw::ObjBase::init
void init()
Object initializer.
Definition
ObjBase.cpp:27
Svc::BufferRepeaterComponentBase
Auto-generated base for BufferRepeater component.
Definition
BufferRepeaterComponentAc.hpp:31
Svc::BufferRepeater
Definition
BufferRepeater.hpp:20
Svc::BufferRepeater::BufferRepeaterFailureOption
BufferRepeaterFailureOption
Definition
BufferRepeater.hpp:25
Svc::BufferRepeater::NO_RESPONSE_ON_OUT_OF_MEMORY
@ NO_RESPONSE_ON_OUT_OF_MEMORY
Definition
BufferRepeater.hpp:26
Svc::BufferRepeater::WARNING_ON_OUT_OF_MEMORY
@ WARNING_ON_OUT_OF_MEMORY
Definition
BufferRepeater.hpp:27
Svc::BufferRepeater::FATAL_ON_OUT_OF_MEMORY
@ FATAL_ON_OUT_OF_MEMORY
Definition
BufferRepeater.hpp:28
Svc::BufferRepeater::NUM_BUFFER_REPEATER_FAILURE_OPTIONS
@ NUM_BUFFER_REPEATER_FAILURE_OPTIONS
Definition
BufferRepeater.hpp:29
Svc::BufferRepeater::configure
void configure(BufferRepeaterFailureOption allocation_failure_response)
Definition
BufferRepeater.cpp:32
Svc::BufferRepeater::~BufferRepeater
~BufferRepeater()
Definition
BufferRepeater.cpp:30
Svc::BufferRepeater::BufferRepeater
BufferRepeater(const char *const compName)
Definition
BufferRepeater.cpp:22
Svc
Definition
ActiveRateGroupCfg.hpp:18
Svc
BufferRepeater
BufferRepeater.hpp
Generated by
1.10.0