F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc Namespace Reference

Namespaces

 DeframerCfg
 
 FpFrameHeader
 
 PolyDbCfg
 
 VersionCfg
 

Classes

class  ActiveLogger_Enabled
 Enabled and disabled state. More...
 
class  ActiveLogger_FilterSeverity
 
class  ActiveLoggerComponentBase
 Auto-generated base for ActiveLogger component. More...
 
class  ActiveRateGroupComponentBase
 Auto-generated base for ActiveRateGroup component. More...
 
class  ActiveTextLoggerComponentBase
 Auto-generated base for ActiveTextLogger component. More...
 
class  AssertFatalAdapterComponentBase
 Auto-generated base for AssertFatalAdapter component. More...
 
class  BufferAccumulator_BlockMode
 
class  BufferAccumulator_OpState
 
class  BufferAccumulatorComponentBase
 Auto-generated base for BufferAccumulator component. More...
 
class  BufferLogger_LogState
 
class  BufferLoggerComponentBase
 Auto-generated base for BufferLogger component. More...
 
class  BufferManagerComponentBase
 Auto-generated base for BufferManager component. More...
 
class  BufferRepeaterComponentBase
 Auto-generated base for BufferRepeater component. More...
 
class  CommandDispatcherComponentBase
 Auto-generated base for CommandDispatcher component. More...
 
class  CmdSequencer_BlockState
 Sequencer blocking state. More...
 
class  CmdSequencer_FileReadStage
 The stage of the file read operation. More...
 
class  CmdSequencer_SeqMode
 The sequencer mode. More...
 
class  CmdSequencerComponentBase
 Auto-generated base for CmdSequencer component. More...
 
class  CmdSplitterComponentBase
 Auto-generated base for CmdSplitter component. More...
 
class  ComLoggerComponentBase
 Auto-generated base for ComLogger component. More...
 
class  BuffQueueDepth
 Array of queue depths for Fw::Buffer types. More...
 
class  ComQueueComponentBase
 Auto-generated base for ComQueue component. More...
 
class  ComQueueDepth
 Array of queue depths for Fw::Com types. More...
 
class  QueueType
 An enumeration of queue data types. More...
 
class  ComSplitterComponentBase
 Auto-generated base for ComSplitter component. More...
 
class  ComStubComponentBase
 Auto-generated base for ComStub component. More...
 
class  InputCyclePort
 
class  OutputCyclePort
 
class  DeframerComponentBase
 Auto-generated base for Deframer component. More...
 
class  DpCatalogComponentBase
 Auto-generated base for DpCatalog component. More...
 
class  DpHdrField
 Header validation error. More...
 
class  DpRecord
 Data structure representing a data product. More...
 
class  DpManagerComponentBase
 Auto-generated base for DpManager component. More...
 
class  InputDpWrittenPort
 
class  OutputDpWrittenPort
 
class  DpWriterComponentBase
 Auto-generated base for DpWriter component. More...
 
class  InputFatalEventPort
 
class  OutputFatalEventPort
 
class  FatalHandlerComponentBase
 Auto-generated base for FatalHandler component. More...
 
class  FileDownlinkComponentBase
 Auto-generated base for FileDownlink component. More...
 
class  InputSendFileCompletePort
 
class  OutputSendFileCompletePort
 
class  InputSendFileRequestPort
 
class  OutputSendFileRequestPort
 
class  SendFileResponse
 Send file response struct. More...
 
class  SendFileStatus
 Send file status enum. More...
 
class  FileManagerComponentBase
 Auto-generated base for FileManager component. More...
 
class  FileUplinkComponentBase
 Auto-generated base for FileUplink component. More...
 
class  FramerComponentBase
 Auto-generated base for Framer component. More...
 
class  GenericHubComponentBase
 Auto-generated base for GenericHub component. More...
 
class  HealthComponentBase
 Auto-generated base for Health component. More...
 
class  LinuxTimerComponentBase
 Auto-generated base for LinuxTimer component. More...
 
class  PassiveTextLoggerComponentBase
 Auto-generated base for PassiveTextLogger component. More...
 
class  PassiveRateGroupComponentBase
 Auto-generated base for PassiveRateGroup component. More...
 
class  InputPingPort
 
class  OutputPingPort
 
class  PolyDbComponentBase
 Auto-generated base for PolyDb component. More...
 
class  MeasurementStatus
 An enumeration for measurement status. More...
 
class  InputPolyPort
 
class  OutputPolyPort
 
class  InputVersionPort
 
class  OutputVersionPort
 
class  VersionStatus
 An enumeration for version status. More...
 
class  PosixTimeComponentBase
 Auto-generated base for PosixTime component. More...
 
class  PrmDb_PrmReadError
 Parameter read error. More...
 
class  PrmDb_PrmWriteError
 Parameter write error. More...
 
class  PrmDbComponentBase
 Auto-generated base for PrmDb component. More...
 
class  RateGroupDriverComponentBase
 Auto-generated base for RateGroupDriver component. More...
 
class  InputSchedPort
 
class  OutputSchedPort
 
class  InputCmdSeqCancelPort
 
class  OutputCmdSeqCancelPort
 
class  InputCmdSeqInPort
 
class  OutputCmdSeqInPort
 
class  SeqDispatcher_CmdSequencerState
 
class  SeqDispatcherComponentBase
 Auto-generated base for SeqDispatcher component. More...
 
class  StaticMemoryComponentBase
 Auto-generated base for StaticMemory component. More...
 
class  SystemResourceEnabled
 
class  SystemResourcesComponentBase
 Auto-generated base for SystemResources component. More...
 
class  TlmChanComponentBase
 Auto-generated base for TlmChan component. More...
 
class  TlmPacketizerComponentBase
 Auto-generated base for TlmPacketizer component. More...
 
class  CustomVersionDb
 Data Structure for custom version Tlm. More...
 
class  VersionComponentBase
 Auto-generated base for Version component. More...
 
class  VersionEnabled
 Tracks versions for project, framework and user defined versions etc. More...
 
class  VersionType
 An enumeration for Version Type. More...
 
class  InputWatchDogPort
 
class  OutputWatchDogPort
 
class  ActiveLoggerImpl
 
class  ActiveRateGroup
 Executes a set of components as part of a rate group. More...
 
class  ActiveTextLogger
 
class  LogFile
 LogFile struct. More...
 
class  AssertFatalAdapterComponentImpl
 
class  BufferAccumulator
 
class  BufferLogger
 
class  BufferManagerComponentImpl
 
class  BufferRepeater
 
class  CommandDispatcherImpl
 Command Dispatcher component class. More...
 
class  CmdSequencerComponentImpl
 
class  AMPCSSequence
 A sequence in AMPCS format. More...
 
class  CmdSplitter
 
class  ComLogger
 
class  ComQueue
 
class  ComSplitter
 
class  ComStub
 
class  Deframer
 Generic deframing component using DeframingProtocol implementation for actual deframing. More...
 
class  DpCatalog
 
class  DpManager
 
class  DpWriter
 
class  FatalHandlerComponentImpl
 
class  FileDownlink
 
class  FileManager
 
class  FileUplink
 
class  Framer
 Generic framing component using FramingProtocol implementation for actual framing. More...
 
class  DeframingProtocol
 Abstract base class representing a deframing protocol. More...
 
class  DeframingProtocolInterface
 interface supplied to the deframing protocol More...
 
class  FprimeFraming
 Implements the F Prime framing protocol. More...
 
class  FprimeDeframing
 Implements the F Prime deframing protocol. More...
 
class  FramingProtocol
 abstract class representing a framing protocol More...
 
class  FramingProtocolInterface
 interface supplied to the framing protocol More...
 
class  GenericHubComponentImpl
 
class  HealthImpl
 Health component implementation class. More...
 
class  LinuxTimerComponentImpl
 
class  ConsoleTextLoggerImpl
 
class  PassiveRateGroup
 
class  PolyDb
 PolyDb Component Class. More...
 
class  PosixTime
 
class  PrmDbImpl
 Component class for managing parameters. More...
 
class  RateGroupDriver
 Implementation class for RateGroupDriver. More...
 
class  SeqDispatcher
 
class  StaticMemoryComponentImpl
 
class  SystemResources
 
class  TlmChan
 
class  TlmPacketizer
 
struct  TlmPacketizerChannelEntry
 
struct  TlmPacketizerPacket
 
struct  TlmPacketizerPacketList
 
class  UdpReceiverComponentImpl
 
class  UdpSenderComponentImpl
 
class  Version
 

Typedefs

typedef ActiveLoggerImpl ActiveLogger
 
typedef ActiveLogger_Enabled Enabled
 
typedef ActiveLogger_FilterSeverity FilterSeverity
 
typedef AssertFatalAdapterComponentImpl AssertFatalAdapter
 
typedef BufferLogger_LogState LogState
 
typedef BufferManagerComponentImpl BufferManager
 
typedef CommandDispatcherImpl CommandDispatcher
 
typedef CmdSequencerComponentImpl CmdSequencer
 
typedef FatalHandlerComponentImpl FatalHandler
 
using GenericHub = GenericHubComponentImpl
 
typedef HealthImpl Health
 
using LinuxTimer = LinuxTimerComponentImpl
 
typedef ConsoleTextLoggerImpl PassiveTextLogger
 
typedef PrmDbImpl PrmDb
 
typedef PrmDb_PrmWriteError PrmWriteError
 
typedef PrmDb_PrmReadError PrmReadError
 
typedef StaticMemoryComponentImpl StaticMemory
 

Enumerations

enum  { ACTIVE_RATE_GROUP_OVERRUN_THROTTLE = 5 }
 
enum  StaticMemoryConfig { STATIC_MEMORY_ALLOCATION_SIZE = 2048 }
 
enum  PacketUpdateMode { PACKET_UPDATE_ALWAYS , PACKET_UPDATE_ON_CHANGE , PACKET_UPDATE_AFTER_FIRST_CHANGE }
 

Variables

static const NATIVE_UINT_TYPE BUFFERMGR_MAX_NUM_BINS = 10
 
static const FwSizeType DP_MAX_DIRECTORIES = 2
 
static const FwSizeType DP_MAX_FILES = 100
 
static const bool FILEDOWNLINK_PACKETS_BY_RUN = false
 
static const bool FILEDOWNLINK_COMMAND_FAILURES_DISABLED = true
 
static const U32 FILEDOWNLINK_INTERNAL_BUFFER_SIZE = FW_COM_BUFFER_MAX_SIZE-sizeof(FwPacketDescriptorType)
 
static const NATIVE_UINT_TYPE MAX_PACKETIZER_PACKETS = 200
 
static const NATIVE_UINT_TYPE TLMPACKETIZER_NUM_TLM_HASH_SLOTS
 
static const NATIVE_UINT_TYPE TLMPACKETIZER_HASH_MOD_VALUE
 
static const NATIVE_UINT_TYPE TLMPACKETIZER_HASH_BUCKETS
 
static const NATIVE_UINT_TYPE TLMPACKETIZER_MAX_MISSING_TLM_CHECK
 
static const PacketUpdateMode PACKET_UPDATE_MODE = PACKET_UPDATE_ON_CHANGE
 
static const NATIVE_UINT_TYPE UDP_RECEIVER_MSG_SIZE = 256
 
static const NATIVE_UINT_TYPE UDP_SENDER_MSG_SIZE = 256
 

Typedef Documentation

◆ ActiveLogger

Definition at line 13 of file ActiveLogger.hpp.

◆ AssertFatalAdapter

◆ BufferManager

◆ CmdSequencer

Definition at line 13 of file CmdSequencer.hpp.

◆ CommandDispatcher

◆ Enabled

Definition at line 16 of file ActiveLoggerImpl.cpp.

◆ FatalHandler

Definition at line 13 of file FatalHandler.hpp.

◆ FilterSeverity

◆ GenericHub

Definition at line 13 of file GenericHub.hpp.

◆ Health

Definition at line 13 of file Health.hpp.

◆ LinuxTimer

Definition at line 13 of file LinuxTimer.hpp.

◆ LogState

Definition at line 17 of file BufferLogger.cpp.

◆ PassiveTextLogger

◆ PrmDb

Definition at line 13 of file PrmDb.hpp.

◆ PrmReadError

Definition at line 20 of file PrmDbImpl.cpp.

◆ PrmWriteError

Definition at line 19 of file PrmDbImpl.cpp.

◆ StaticMemory

Definition at line 13 of file StaticMemory.hpp.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
ACTIVE_RATE_GROUP_OVERRUN_THROTTLE 

Number of overruns allowed before overrun event is throttled.

Definition at line 20 of file ActiveRateGroupCfg.hpp.

◆ PacketUpdateMode

Enumerator
PACKET_UPDATE_ALWAYS 
PACKET_UPDATE_ON_CHANGE 
PACKET_UPDATE_AFTER_FIRST_CHANGE 

Definition at line 34 of file TlmPacketizerCfg.hpp.

◆ StaticMemoryConfig

Enumerator
STATIC_MEMORY_ALLOCATION_SIZE 

Definition at line 11 of file StaticMemoryConfig.hpp.

Variable Documentation

◆ BUFFERMGR_MAX_NUM_BINS

const NATIVE_UINT_TYPE Svc::BUFFERMGR_MAX_NUM_BINS = 10
static

Definition at line 7 of file BufferManagerComponentImplCfg.hpp.

◆ DP_MAX_DIRECTORIES

const FwSizeType Svc::DP_MAX_DIRECTORIES = 2
static

Definition at line 16 of file DpCatalogCfg.hpp.

◆ DP_MAX_FILES

const FwSizeType Svc::DP_MAX_FILES = 100
static

Definition at line 17 of file DpCatalogCfg.hpp.

◆ FILEDOWNLINK_COMMAND_FAILURES_DISABLED

const bool Svc::FILEDOWNLINK_COMMAND_FAILURES_DISABLED = true
static

Definition at line 20 of file FileDownlinkCfg.hpp.

◆ FILEDOWNLINK_INTERNAL_BUFFER_SIZE

const U32 Svc::FILEDOWNLINK_INTERNAL_BUFFER_SIZE = FW_COM_BUFFER_MAX_SIZE-sizeof(FwPacketDescriptorType)
static

Definition at line 23 of file FileDownlinkCfg.hpp.

◆ FILEDOWNLINK_PACKETS_BY_RUN

const bool Svc::FILEDOWNLINK_PACKETS_BY_RUN = false
static

Definition at line 15 of file FileDownlinkCfg.hpp.

◆ MAX_PACKETIZER_PACKETS

const NATIVE_UINT_TYPE Svc::MAX_PACKETIZER_PACKETS = 200
static

Definition at line 19 of file TlmPacketizerCfg.hpp.

◆ PACKET_UPDATE_MODE

const PacketUpdateMode Svc::PACKET_UPDATE_MODE = PACKET_UPDATE_ON_CHANGE
static

Definition at line 40 of file TlmPacketizerCfg.hpp.

◆ TLMPACKETIZER_HASH_BUCKETS

const NATIVE_UINT_TYPE Svc::TLMPACKETIZER_HASH_BUCKETS
static
Initial value:
=
1000

Definition at line 27 of file TlmPacketizerCfg.hpp.

◆ TLMPACKETIZER_HASH_MOD_VALUE

const NATIVE_UINT_TYPE Svc::TLMPACKETIZER_HASH_MOD_VALUE
static
Initial value:
=
99

Definition at line 23 of file TlmPacketizerCfg.hpp.

◆ TLMPACKETIZER_MAX_MISSING_TLM_CHECK

const NATIVE_UINT_TYPE Svc::TLMPACKETIZER_MAX_MISSING_TLM_CHECK
static
Initial value:
=
25

Definition at line 30 of file TlmPacketizerCfg.hpp.

◆ TLMPACKETIZER_NUM_TLM_HASH_SLOTS

const NATIVE_UINT_TYPE Svc::TLMPACKETIZER_NUM_TLM_HASH_SLOTS
static
Initial value:
=
15

Definition at line 20 of file TlmPacketizerCfg.hpp.

◆ UDP_RECEIVER_MSG_SIZE

const NATIVE_UINT_TYPE Svc::UDP_RECEIVER_MSG_SIZE = 256
static

Definition at line 14 of file UdpReceiverComponentImplCfg.hpp.

◆ UDP_SENDER_MSG_SIZE

const NATIVE_UINT_TYPE Svc::UDP_SENDER_MSG_SIZE = 256
static

Definition at line 14 of file UdpSenderComponentImplCfg.hpp.