Changes between Initial Version and Version 1 of Cross/CognitiveRadioAPI

Timestamp:

04/10/09 16:43:38 (15 years ago)

Author:

trnewman

Comment:

--

Cross/CognitiveRadioAPI

@@ +1 @@
+= Cognitive Radio API =
+
+=== Public Member Functions ===
+
+{{{
+#!cpp
+bool ParseRadioConfiguration(char* fileName)
+}}}
+
+{{{
+#!cpp
+void ListCurrentRadioConfiguration()
+}}}
+
+{{{
+#!cpp
+Observables* GetRadioObservables()
+}}}
+
+{{{
+#!cpp
+Parameters* GetRadioParameters()
+}}}
+
+{{{
+#!cpp
+Utilities* GetRadioUtilities()
+}}}
+
+
+{{{
+#!cpp
+uint32_t* GetConnectedCognitiveEngines()
+}}}
+
+{{{
+#!cpp
+uint32_t* GetConnectedPolicyEngines()
+}}}
+
+{{{
+#!cpp
+uint32_t* GetConnectedManagementServiceLayers()
+}}}
+
+{{{
+#!cpp
+uint32_t* GetConnectedComponents()
+}}}
+
+{{{
+#!cpp
+Component* GetComponentInformation(uint32_t ID)
+}}}
+
+{{{
+#!cpp
+Parameters* GetOptimalParameters(Observables* radioObservables)
+}}}
+
+{{{
+#!cpp
+bool UpdateParameterPerformance(Parameters* radioParameters, Observables* radioObservables, Utilities* radioUtilities)
+}}}
+  Update the actual utility values in response to a previous parameter optimization.
+
+  This method is called when performance feedback is available for a recent parameter optimization.  This allows the Cognitive Engine to better understand the relationships between the operating parameters and the objective performance.
+
+{{{
+#!cpp
+bool DeactivateComponent(uint32_t ID)
+}}}
+
+{{{
+#!cpp
+bool ActivateComponent(uint32_t ID)
+}}}
+
+{{{
+#!cpp
+bool DisconnectComponent(uint32_t ID)
+}}}
+
+{{{
+#!cpp
+bool Shutdown()
+}}}
+  Shutdown the Cognitive Radio System.
+
+  This method will perform a clean shutdown of the entire Cognitive Radio System.  This includes calls to disconnect each attached component.
+
+=== Private Member Functions ===
+
+{{{
+#!cpp
+bool SendExperience(uint32_t ID)
+}}}
+
+  Sends the local cache of past experience to the Cognitive Engine with unique identification number ''ID''.
+
+  This method is called by the RegisterCE method.  It is one stage of the initialization of a Cognitive Engine.  The single experience consists of a set of Parameter, Observables, and Utilities.  This stage is used to provide optional ''recent'' information to the Cognitive Engine so that it may make better decisions for parameter optimization.