mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 00:44:37 -06:00
10f2b49d3f
* Use Fw::TimeInterval in LinuxTimer * Fix Linux FD typo * Fix interval timer UT * Format * Fix assert casts * Fix ComLogger UTs * Fix FppTest microseconds * Fix casting * Fix overflow
91 lines
4.3 KiB
C++
91 lines
4.3 KiB
C++
// ======================================================================
|
||
// \title Topology.hpp
|
||
// \author mstarch
|
||
// \brief header file containing the topology instantiation definitions
|
||
//
|
||
// \copyright
|
||
// Copyright 2009-2022, by the California Institute of Technology.
|
||
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
||
// acknowledged.
|
||
// ======================================================================
|
||
#ifndef REF_REFTOPOLOGY_HPP
|
||
#define REF_REFTOPOLOGY_HPP
|
||
// Included for access to Ref::TopologyState and Ref::ConfigObjects::pingEntries. These definitions are required by the
|
||
// autocoder, but are also used in this hand-coded topology.
|
||
#include <Ref/Top/RefTopologyDefs.hpp>
|
||
|
||
// Remove unnecessary Ref:: qualifications
|
||
using namespace Ref;
|
||
namespace Ref {
|
||
/**
|
||
* \brief initialize and run the F´ topology
|
||
*
|
||
* Initializes, configures, and runs the F´ topology. This is performed through a series of steps, some provided via
|
||
* autocoded functions, and others provided via the functions implementation. These steps are:
|
||
*
|
||
* 1. Call the autocoded `initComponents()` function initializing each component via the `component.init` method
|
||
* 2. Call the autocoded `setBaseIds()` function to set the base IDs (offset) for each component instance
|
||
* 3. Call the autocoded `connectComponents()` function to wire-together the topology of components
|
||
* 4. Configure components requiring custom configuration
|
||
* 5. Call the autocoded `loadParameters()` function to cause each component to load initial parameter values
|
||
* 6. Call the autocoded `startTasks()` function to start the active component tasks
|
||
* 7. Start tasks not owned by active components
|
||
*
|
||
* Step 4 and step 7 are custom and supplied by the project. The ordering of steps 1, 2, 3, 5, and 6 are critical for
|
||
* F´ topologies to function. Configuration (step 4) typically assumes a connect but not started topology and is thus
|
||
* inserted between step 3 and 5. Step 7 may come before or after the active component initializations. Since these
|
||
* custom tasks often start radio communication it is convenient to start them last.
|
||
*
|
||
* The state argument carries command line inputs used to setup the topology. For an explanation of the required type
|
||
* Ref::TopologyState see: RefTopologyDefs.hpp.
|
||
*
|
||
* \param state: object shuttling CLI arguments (hostname, port) needed to construct the topology
|
||
*/
|
||
void setupTopology(const TopologyState& state);
|
||
|
||
/**
|
||
* \brief teardown the F´ topology
|
||
*
|
||
* Tears down the F´ topology in preparation for shutdown. This is done via a series of steps, some provided by
|
||
* autocoded functions, and others provided via the function implementation. These steps are:
|
||
*
|
||
* 1. Call the autocoded `stopTasks()` function to stop the tasks started by `startTasks()` (active components)
|
||
* 2. Call the autocoded `freeThreads()` function to join to the tasks started by `startTasks()`
|
||
* 3. Stop the tasks not owned by active components
|
||
* 4. Join to the tasks not owned by active components
|
||
* 5. Deallocate other resources
|
||
*
|
||
* Step 1, 2, 3, and 4 must occur in-order as the tasks must be stopped before being joined. These tasks must be stopped
|
||
* and joined before any active resources may be deallocated.
|
||
*
|
||
* For an explanation of the required type Ref::TopologyState see: RefTopologyDefs.hpp.
|
||
*
|
||
* \param state: state object provided to setupTopology
|
||
*/
|
||
void teardownTopology(const TopologyState& state);
|
||
|
||
/**
|
||
* \brief cycle the rate group driver based in a system timer
|
||
*
|
||
* In order to be a portable demonstration, the reference topology does not have a direct hardware timer that is typically used
|
||
* in embedded applications. Instead, a linux system timer is used to drive the rate groups at 1Hz. The slower rate groups are
|
||
* derived from this fundamental rate using the RateGroupDriver component to divide the rate down to slower rates.
|
||
*
|
||
* For embedded Linux, this could be used to drive the system rate groups. For other embedded systems, projects should write components
|
||
* that implement whatever timers are available for that platform in place of Svc/LinuxTimer.
|
||
*
|
||
* This loop is stopped via a stopRateGroups call.
|
||
*
|
||
*/
|
||
void startRateGroups(const Fw::TimeInterval& interval);
|
||
|
||
/**
|
||
* \brief stop the rate groups
|
||
*
|
||
* This stops the cycle started by startRateGroups.
|
||
*/
|
||
void stopRateGroups();
|
||
|
||
} // namespace Ref
|
||
#endif
|