F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
FppConstantsAc.hpp File Reference

Go to the source code of this file.

Namespaces

 ComCfg
 
 Fw
 Implementation of malloc based allocator.
 
 Fw::DpCfg
 
 Svc
 RateGroupDivider component implementation.
 
 Svc::FileDispatcherCfg
 
 Svc::Fpy
 
 Svc::GenericHubCfg
 
 Os
 

Enumerations

enum  { ActiveRateGroupOutputPorts = 10 }
 Number of rate group member output ports for ActiveRateGroup. More...
 
enum  { PassiveRateGroupOutputPorts = 10 }
 Number of rate group member output ports for PassiveRateGroup. More...
 
enum  { RateGroupDriverRateGroupPorts = 3 }
 Used to drive rate groups. More...
 
enum  { CmdDispatcherComponentCommandPorts = 30 }
 Used for command and registration ports. More...
 
enum  { CmdDispatcherSequencePorts = 5 }
 Used for uplink/sequencer buffer/response ports. More...
 
enum  { SeqDispatcherSequencerPorts = 2 }
 Used for dispatching sequences to command sequencers. More...
 
enum  { CmdSplitterPorts = 5 }
 Used for sizing the command splitter input arrays. More...
 
enum  { StaticMemoryAllocations = 4 }
 Number of static memory allocations. More...
 
enum  { HealthPingPorts = 25 }
 Used to ping active components. More...
 
enum  { FileDownCompletePorts = 1 }
 Used for broadcasting completed file downlinks. More...
 
enum  { ComQueueComPorts = 2 }
 Used for number of Fw::Com type ports supported by Svc::ComQueue. More...
 
enum  { ComQueueBufferPorts = 1 }
 Used for number of Fw::Buffer type ports supported by Svc::ComQueue. More...
 
enum  { BufferRepeaterOutputPorts = 10 }
 Used for maximum number of connected buffer repeater consumers. More...
 
enum  { DpManagerNumPorts = 5 }
 Size of port array for DpManager. More...
 
enum  { DpWriterNumProcPorts = 5 }
 Size of processing port array for DpWriter. More...
 
enum  { FileNameStringSize = 200 }
 The size of a file name string. More...
 
enum  { FwAssertTextSize = 256 }
 The size of an assert text string. More...
 
enum  { AssertFatalAdapterEventFileSize = 200 }
 
enum  { SIZE_OF_FwPacketDescriptorType = 2 }
 Size of FwPacketDescriptorType in bytes. More...
 
enum  { ComCfg::SpacecraftId = 68 }
 Spacecraft ID (10 bits) for CCSDS Data Link layer. More...
 
enum  { ComCfg::TmFrameFixedSize = 1024 }
 Fixed size of CCSDS TM frames. More...
 
enum  { ComCfg::AggregationSize = 1009 }
 Aggregation buffer for ComAggregator component. More...
 
enum  { Fw::DpCfg::CONTAINER_USER_DATA_SIZE = 32 }
 
enum  { Svc::FileDispatcherCfg::FILE_DISPATCHER_MAX_TABLE_SIZE = 10 }
 
enum  { SIZE_OF_FwIdType = 4 }
 Size of FwIdType in bytes. More...
 
enum  { SIZE_OF_FwChanIdType = 4 }
 Size of FwChanIdType in bytes. More...
 
enum  { SIZE_OF_FwEventIdType = 4 }
 Size of FwEventIdType in bytes. More...
 
enum  { SIZE_OF_FwOpcodeType = 4 }
 Size of FwOpcodeType in bytes. More...
 
enum  { SIZE_OF_FwPrmIdType = 4 }
 Size of FwPrmIdType in bytes. More...
 
enum  { FW_OBJ_SIMPLE_REG_BUFF_SIZE = 255 }
 
enum  { FW_QUEUE_NAME_BUFFER_SIZE = 80 }
 Specifies the size of the string holding the queue name for queues. More...
 
enum  { FW_TASK_NAME_BUFFER_SIZE = 80 }
 Specifies the size of the string holding the task name for active components and tasks. More...
 
enum  { FW_COM_BUFFER_MAX_SIZE = 512 }
 Specifies the size of the buffer that contains a communications packet. More...
 
enum  { FW_SM_SIGNAL_BUFFER_MAX_SIZE = 128 }
 Specifies the size of the buffer attached to state machine signals. More...
 
enum  { FW_CMD_ARG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized command arguments. More...
 
enum  { FW_CMD_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a command argument. More...
 
enum  { FW_LOG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized log arguments. More...
 
enum  { FW_LOG_STRING_MAX_SIZE = 200 }
 
enum  { FW_TLM_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized telemetry value. More...
 
enum  { FW_STATEMENT_ARG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized telemetry value. More...
 
enum  { FW_TLM_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a telemetry channel. More...
 
enum  { FW_PARAM_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized parameter value. More...
 
enum  { FW_PARAM_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a parameter. More...
 
enum  { FW_FILE_BUFFER_MAX_SIZE = 512 }
 Specifies the maximum size of a file downlink chunk. More...
 
enum  { FW_INTERNAL_INTERFACE_STRING_MAX_SIZE = 256 }
 Specifies the maximum size of a string in an interface call. More...
 
enum  { FW_LOG_TEXT_BUFFER_SIZE = 256 }
 Defines the size of the text log string buffer. Should be large enough for format string and arguments. More...
 
enum  { FW_FIXED_LENGTH_STRING_SIZE = 256 }
 
enum  { FW_OBJ_SIMPLE_REG_ENTRIES = 500 }
 For the simple object registry provided with the framework, this specifies how many objects the registry will store. More...
 
enum  { FW_QUEUE_SIMPLE_QUEUE_ENTRIES = 100 }
 For the simple queue registry provided with the framework, this specifies how many queues the registry will store. More...
 
enum  { FW_ASSERT_COUNT_MAX = 10 }
 Maximum number of cascading FW_ASSERT check failures before forcing a system assert. More...
 
enum  { FW_CONTEXT_DONT_CARE = 255 }
 Don't care value for time contexts in sequences. More...
 
enum  { FW_SERIALIZE_TRUE_VALUE = 255 }
 Value encoded during serialization for boolean true. More...
 
enum  { FW_SERIALIZE_FALSE_VALUE = 0 }
 Value encoded during serialization for boolean false. More...
 
enum  { Svc::Fpy::MAX_SEQUENCE_ARG_COUNT = 16 }
 The maximum number of arguments a sequence can have. More...
 
enum  { Svc::Fpy::MAX_SEQUENCE_STATEMENT_COUNT = 2048 }
 The maximum number of statements a sequence can have. More...
 
enum  { Svc::Fpy::MAX_STACK_SIZE = 65535 }
 the maximum number of bytes in a stack More...
 
enum  { Svc::Fpy::MAX_DIRECTIVE_SIZE = 2048 }
 the maximum number of bytes in a directive More...
 
enum  { Svc::GenericHubCfg::NumSerialInputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumBufferInputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumSerialOutputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumBufferOutputPorts = 10 }
 
enum  { Os::FILE_MODE_IRUSR = 64 }
 
enum  { Os::FILE_MODE_IWUSR = 128 }
 
enum  { Os::FILE_MODE_IXUSR = 256 }
 
enum  { Os::FILE_MODE_IRWXU = 448 }
 
enum  { Os::FILE_MODE_IRGRP = 8 }
 
enum  { Os::FILE_MODE_IWGRP = 16 }
 
enum  { Os::FILE_MODE_IXGRP = 32 }
 
enum  { Os::FILE_MODE_IRWXG = 56 }
 
enum  { Os::FILE_MODE_IROTH = 1 }
 
enum  { Os::FILE_MODE_IWOTH = 2 }
 
enum  { Os::FILE_MODE_IXOTH = 4 }
 
enum  { Os::FILE_MODE_IRWXO = 7 }
 
enum  { Os::FILE_MODE_ISUID = 2048 }
 
enum  { Os::FILE_MODE_ISGID = 1024 }
 
enum  { Os::FILE_MODE_ISVTX = 512 }
 
enum  { Os::FILE_DEFAULT_CREATE_MODE = 219 }
 
enum  { FW_CONSOLE_HANDLE_MAX_SIZE = 24 }
 Maximum size of a handle for Os::Console. More...
 
enum  { FW_TASK_HANDLE_MAX_SIZE = 40 }
 Maximum size of a handle for Os::Task. More...
 
enum  { FW_FILE_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::File. More...
 
enum  { FW_MUTEX_HANDLE_MAX_SIZE = 72 }
 Maximum size of a handle for Os::Mutex. More...
 
enum  { FW_QUEUE_HANDLE_MAX_SIZE = 368 }
 Maximum size of a handle for Os::Queue. More...
 
enum  { FW_DIRECTORY_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Directory. More...
 
enum  { FW_FILESYSTEM_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::FileSystem. More...
 
enum  { FW_RAW_TIME_HANDLE_MAX_SIZE = 56 }
 Maximum size of a handle for Os::RawTime. More...
 
enum  { FW_RAW_TIME_SERIALIZATION_MAX_SIZE = 8 }
 Maximum allowed serialization size for Os::RawTime objects. More...
 
enum  { FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE = 56 }
 Maximum size of a handle for Os::ConditionVariable. More...
 
enum  { FW_CPU_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Cpu. More...
 
enum  { FW_MEMORY_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Memory. More...
 
enum  { FW_HANDLE_ALIGNMENT = 8 }
 Alignment of handle storage. More...
 
enum  { FW_FILE_CHUNK_SIZE = 512 }
 Chunk size for working with files in the OSAL layer. More...
 
enum  { Svc::MAX_CONFIGURABLE_TLMPACKETIZER_GROUP = 3 }
 Greatest packet group. More...
 
enum  { Svc::NUM_CONFIGURABLE_TLMPACKETIZER_GROUPS = 4 }
 
enum  { Svc::TELEMETRY_SEND_PORTS = 3 }
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Number of rate group member output ports for ActiveRateGroup.

Enumerator
ActiveRateGroupOutputPorts 

Definition at line 13 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Number of rate group member output ports for PassiveRateGroup.

Enumerator
PassiveRateGroupOutputPorts 

Definition at line 18 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used to drive rate groups.

Enumerator
RateGroupDriverRateGroupPorts 

Definition at line 23 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for command and registration ports.

Enumerator
CmdDispatcherComponentCommandPorts 

Definition at line 28 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for uplink/sequencer buffer/response ports.

Enumerator
CmdDispatcherSequencePorts 

Definition at line 33 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for dispatching sequences to command sequencers.

Enumerator
SeqDispatcherSequencerPorts 

Definition at line 38 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for sizing the command splitter input arrays.

Enumerator
CmdSplitterPorts 

Definition at line 43 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Number of static memory allocations.

Enumerator
StaticMemoryAllocations 

Definition at line 48 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used to ping active components.

Enumerator
HealthPingPorts 

Definition at line 53 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for broadcasting completed file downlinks.

Enumerator
FileDownCompletePorts 

Definition at line 58 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for number of Fw::Com type ports supported by Svc::ComQueue.

Enumerator
ComQueueComPorts 

Definition at line 63 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for number of Fw::Buffer type ports supported by Svc::ComQueue.

Enumerator
ComQueueBufferPorts 

Definition at line 68 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for maximum number of connected buffer repeater consumers.

Enumerator
BufferRepeaterOutputPorts 

Definition at line 73 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of port array for DpManager.

Enumerator
DpManagerNumPorts 

Definition at line 78 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of processing port array for DpWriter.

Enumerator
DpWriterNumProcPorts 

Definition at line 83 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of a file name string.

Enumerator
FileNameStringSize 

Definition at line 88 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of an assert text string.

Enumerator
FwAssertTextSize 

Definition at line 93 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of a file name in an AssertFatalAdapter event Note: File names in assertion failures are also truncated by the constants FW_ASSERT_TEXT_SIZE and FW_LOG_STRING_MAX_SIZE, set in FpConfig.h.

Enumerator
AssertFatalAdapterEventFileSize 

Definition at line 101 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwPacketDescriptorType in bytes.

Enumerator
SIZE_OF_FwPacketDescriptorType 

Definition at line 106 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwIdType in bytes.

Enumerator
SIZE_OF_FwIdType 

Definition at line 156 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwChanIdType in bytes.

Enumerator
SIZE_OF_FwChanIdType 

Definition at line 161 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwEventIdType in bytes.

Enumerator
SIZE_OF_FwEventIdType 

Definition at line 166 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwOpcodeType in bytes.

Enumerator
SIZE_OF_FwOpcodeType 

Definition at line 171 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of FwPrmIdType in bytes.

Enumerator
SIZE_OF_FwPrmIdType 

Definition at line 176 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

When dumping the contents of the registry, this specifies the size of the buffer used to store object names. Should be >= FW_OBJ_NAME_BUFFER_SIZE.

Enumerator
FW_OBJ_SIMPLE_REG_BUFF_SIZE 

Definition at line 182 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the string holding the queue name for queues.

Enumerator
FW_QUEUE_NAME_BUFFER_SIZE 

Definition at line 187 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the string holding the task name for active components and tasks.

Enumerator
FW_TASK_NAME_BUFFER_SIZE 

Definition at line 192 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains a communications packet.

Enumerator
FW_COM_BUFFER_MAX_SIZE 

Definition at line 197 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer attached to state machine signals.

Enumerator
FW_SM_SIGNAL_BUFFER_MAX_SIZE 

Definition at line 202 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized command arguments.

Enumerator
FW_CMD_ARG_BUFFER_MAX_SIZE 

Definition at line 207 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a command argument.

Enumerator
FW_CMD_STRING_MAX_SIZE 

Definition at line 212 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized log arguments.

Enumerator
FW_LOG_BUFFER_MAX_SIZE 

Definition at line 217 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a log event Note: This constant truncates file names in assertion failure event reports

Enumerator
FW_LOG_STRING_MAX_SIZE 

Definition at line 223 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized telemetry value.

Enumerator
FW_TLM_BUFFER_MAX_SIZE 

Definition at line 228 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized telemetry value.

Enumerator
FW_STATEMENT_ARG_BUFFER_MAX_SIZE 

Definition at line 233 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a telemetry channel.

Enumerator
FW_TLM_STRING_MAX_SIZE 

Definition at line 238 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized parameter value.

Enumerator
FW_PARAM_BUFFER_MAX_SIZE 

Definition at line 243 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a parameter.

Enumerator
FW_PARAM_STRING_MAX_SIZE 

Definition at line 248 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a file downlink chunk.

Enumerator
FW_FILE_BUFFER_MAX_SIZE 

Definition at line 253 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in an interface call.

Enumerator
FW_INTERNAL_INTERFACE_STRING_MAX_SIZE 

Definition at line 258 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Defines the size of the text log string buffer. Should be large enough for format string and arguments.

Enumerator
FW_LOG_TEXT_BUFFER_SIZE 

Definition at line 263 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Configuration for Fw::String Note: FPrimeBasicTypes.hpp needs to be updated to sync enum

Enumerator
FW_FIXED_LENGTH_STRING_SIZE 

Definition at line 269 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

For the simple object registry provided with the framework, this specifies how many objects the registry will store.

Enumerator
FW_OBJ_SIMPLE_REG_ENTRIES 

Definition at line 274 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

For the simple queue registry provided with the framework, this specifies how many queues the registry will store.

Enumerator
FW_QUEUE_SIMPLE_QUEUE_ENTRIES 

Definition at line 279 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum number of cascading FW_ASSERT check failures before forcing a system assert.

Enumerator
FW_ASSERT_COUNT_MAX 

Definition at line 284 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Don't care value for time contexts in sequences.

Enumerator
FW_CONTEXT_DONT_CARE 

Definition at line 289 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Value encoded during serialization for boolean true.

Enumerator
FW_SERIALIZE_TRUE_VALUE 

Definition at line 294 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Value encoded during serialization for boolean false.

Enumerator
FW_SERIALIZE_FALSE_VALUE 

Definition at line 299 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Console.

Enumerator
FW_CONSOLE_HANDLE_MAX_SIZE 

Definition at line 433 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Task.

Enumerator
FW_TASK_HANDLE_MAX_SIZE 

Definition at line 438 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::File.

Enumerator
FW_FILE_HANDLE_MAX_SIZE 

Definition at line 443 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Mutex.

Enumerator
FW_MUTEX_HANDLE_MAX_SIZE 

Definition at line 448 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Queue.

Enumerator
FW_QUEUE_HANDLE_MAX_SIZE 

Definition at line 453 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Directory.

Enumerator
FW_DIRECTORY_HANDLE_MAX_SIZE 

Definition at line 458 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::FileSystem.

Enumerator
FW_FILESYSTEM_HANDLE_MAX_SIZE 

Definition at line 463 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::RawTime.

Enumerator
FW_RAW_TIME_HANDLE_MAX_SIZE 

Definition at line 468 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum allowed serialization size for Os::RawTime objects.

Enumerator
FW_RAW_TIME_SERIALIZATION_MAX_SIZE 

Definition at line 473 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::ConditionVariable.

Enumerator
FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE 

Definition at line 478 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Cpu.

Enumerator
FW_CPU_HANDLE_MAX_SIZE 

Definition at line 483 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Memory.

Enumerator
FW_MEMORY_HANDLE_MAX_SIZE 

Definition at line 488 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Alignment of handle storage.

Enumerator
FW_HANDLE_ALIGNMENT 

Definition at line 493 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Chunk size for working with files in the OSAL layer.

Enumerator
FW_FILE_CHUNK_SIZE 

Definition at line 498 of file FppConstantsAc.hpp.