## On this page

  

 

 # i\_activity

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1 

<a id="l00005" name="l00005"></a> 5 

<a id="l00006" name="l00006"></a> 6\#pragma once

<a id="l00007" name="l00007"></a> 7 

<a id="l00008" name="l00008"></a> 8\#include "core/service/parameter/simulation\_parameters.h"

<a id="l00009" name="l00009"></a> 9\#include "core/time/i\_clock/timestamp.h"

<a id="l00010" name="l00010"></a> 10\#include &lt;chrono&gt;

<a id="l00011" name="l00011"></a> 11\#include &lt;memory&gt;

<a id="l00012" name="l00012"></a> 12\#include &lt;string&gt;

<a id="l00013" name="l00013"></a> 13 

<a id="l00018" name="l00018"></a> 18namespace [simulation\_framework](namespacesimulation__framework.xhtml)

<a id="l00019" name="l00019"></a> 19{

<a id="l00020" name="l00020"></a> 20namespace [core](namespacecore.xhtml)

<a id="l00021" name="l00021"></a> 21{

<a id="l00022" name="l00022"></a> 22namespace lifecycle

<a id="l00023" name="l00023"></a> 23{

<a id="l00024" name="l00024"></a> 24 

<a id="l00029" name="l00029"></a>[ 29](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml)class [IActivity](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml)

<a id="l00030" name="l00030"></a> 30{

<a id="l00031" name="l00031"></a> 31 public:

<a id="l00033" name="l00033"></a>[ 33](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#aa2353eb3f2ef5955c1c3c2d1024c8c48) virtual [~IActivity](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#aa2353eb3f2ef5955c1c3c2d1024c8c48)() = default;

<a id="l00034" name="l00034"></a> 34 

<a id="l00037" name="l00037"></a>[ 37](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ada1e5ab14eb5c159068ccbfc1f8e559c) virtual void [Init](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ada1e5ab14eb5c159068ccbfc1f8e559c)() = 0;

<a id="l00038" name="l00038"></a> 38 

<a id="l00042" name="l00042"></a>[ 42](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a29ff4fb0ec86c24b24ff9296107df773) virtual void [WaitForPubSubConnection](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a29ff4fb0ec86c24b24ff9296107df773)() = 0;

<a id="l00043" name="l00043"></a> 43 

<a id="l00046" name="l00046"></a>[ 46](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a8ae00ca0fb6cf1116435bdbdfa573188) virtual void [Step](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a8ae00ca0fb6cf1116435bdbdfa573188)() = 0;

<a id="l00047" name="l00047"></a> 47 

<a id="l00050" name="l00050"></a>[ 50](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a1753af46ca02f6d39442afa25ddca513) virtual void [Shutdown](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a1753af46ca02f6d39442afa25ddca513)() = 0;

<a id="l00051" name="l00051"></a> 51 

<a id="l00054" name="l00054"></a>[ 54](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ab0dedc5b4b7007b92f95e3356d8808bf) virtual std::string [GetName](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ab0dedc5b4b7007b92f95e3356d8808bf)() const = 0;

<a id="l00055" name="l00055"></a> 55 

<a id="l00059" name="l00059"></a>[ 59](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#af4306329bbb903f70891f1e01095fc37) virtual time::Timestamp [GetCurrentTimestamp](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#af4306329bbb903f70891f1e01095fc37)() const = 0;

<a id="l00060" name="l00060"></a> 60 

<a id="l00064" name="l00064"></a>[ 64](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a2434dec1d575d7f48305c09b4117a9c2) virtual std::chrono::milliseconds [GetCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a2434dec1d575d7f48305c09b4117a9c2)() const = 0;

<a id="l00065" name="l00065"></a> 65 

<a id="l00069" name="l00069"></a>[ 69](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a821e06744ce45c6cab51f194277dc829) virtual std::vector&lt;File&gt; [GetInputFiles](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a821e06744ce45c6cab51f194277dc829)() const = 0;

<a id="l00070" name="l00070"></a> 70 

<a id="l00074" name="l00074"></a>[ 74](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ad282fdd8de94e0990b2ef2068a3a136e) virtual std::string [GetSimulationOutputDirectory](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ad282fdd8de94e0990b2ef2068a3a136e)() const = 0;

<a id="l00075" name="l00075"></a> 75 

<a id="l00078" name="l00078"></a>[ 78](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a08c573b82ec098a7ff5e31d5d827a40f) virtual void [SetUpCommunication](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a08c573b82ec098a7ff5e31d5d827a40f)() = 0;

<a id="l00079" name="l00079"></a> 79};



<a id="l00080" name="l00080"></a> 80 

<a id="l00081" name="l00081"></a> 81} // namespace lifecycle

<a id="l00082" name="l00082"></a> 82} // namespace core

<a id="l00083" name="l00083"></a> 83} // namespace simulation\_framework

[simulation\_framework::core::lifecycle::IActivity](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml)

Interface for simulation activities.

**Definition** [i\_activity.h:30](i__activity_8h_source.xhtml#l00029)



[simulation\_framework::core::lifecycle::IActivity::SetUpCommunication](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a08c573b82ec098a7ff5e31d5d827a40f)

virtual void SetUpCommunication()=0

Sets up the Pub/Sub communication for the activity.



[simulation\_framework::core::lifecycle::IActivity::Shutdown](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a1753af46ca02f6d39442afa25ddca513)

virtual void Shutdown()=0

Shuts down the activity.



[simulation\_framework::core::lifecycle::IActivity::GetCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a2434dec1d575d7f48305c09b4117a9c2)

virtual std::chrono::milliseconds GetCycleTime() const =0

Retrieves the cycle time of the activity.



[simulation\_framework::core::lifecycle::IActivity::WaitForPubSubConnection](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a29ff4fb0ec86c24b24ff9296107df773)

virtual void WaitForPubSubConnection()=0

Waits until Pub/Sub pairing is complete.



[simulation\_framework::core::lifecycle::IActivity::GetInputFiles](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a821e06744ce45c6cab51f194277dc829)

virtual std::vector&lt; File &gt; GetInputFiles() const =0

Retrieves the list of input files required for the simulation.



[simulation\_framework::core::lifecycle::IActivity::Step](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#a8ae00ca0fb6cf1116435bdbdfa573188)

virtual void Step()=0

Executes one step of the activity.



[simulation\_framework::core::lifecycle::IActivity::~IActivity](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#aa2353eb3f2ef5955c1c3c2d1024c8c48)

virtual ~IActivity()=default

Virtual destructor for proper cleanup of derived classes.



[simulation\_framework::core::lifecycle::IActivity::GetName](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ab0dedc5b4b7007b92f95e3356d8808bf)

virtual std::string GetName() const =0

Retrieves the name of the activity.



[simulation\_framework::core::lifecycle::IActivity::GetSimulationOutputDirectory](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ad282fdd8de94e0990b2ef2068a3a136e)

virtual std::string GetSimulationOutputDirectory() const =0

Retrieves the output directory for simulation results.



[simulation\_framework::core::lifecycle::IActivity::Init](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#ada1e5ab14eb5c159068ccbfc1f8e559c)

virtual void Init()=0

Initializes the activity.



[simulation\_framework::core::lifecycle::IActivity::GetCurrentTimestamp](classsimulation__framework_1_1core_1_1lifecycle_1_1IActivity.xhtml#af4306329bbb903f70891f1e01095fc37)

virtual time::Timestamp GetCurrentTimestamp() const =0

Retrieves the current simulation timestamp.



[core](namespacecore.xhtml)

The namespace for all core functionalities under namespace simulation_framework.



[simulation\_framework](namespacesimulation__framework.xhtml)

The top namespace for simulation framework.