diff --git a/fr_initial_config/.buildinfo b/fr_initial_config/.buildinfo index 14a94209..cad51327 100644 --- a/fr_initial_config/.buildinfo +++ b/fr_initial_config/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9e3779161b21f635d17cf09455699b8d +config: 8e8e4c5103644294a74887633a41fbe4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/fr_initial_config/.doctrees/developer/reference/api/common.doctree b/fr_initial_config/.doctrees/developer/reference/api/common.doctree index ce05a534..01f71c73 100644 Binary files a/fr_initial_config/.doctrees/developer/reference/api/common.doctree and b/fr_initial_config/.doctrees/developer/reference/api/common.doctree differ diff --git a/fr_initial_config/.doctrees/environment.pickle b/fr_initial_config/.doctrees/environment.pickle index e8c6a7e9..3f7c2652 100644 Binary files a/fr_initial_config/.doctrees/environment.pickle and b/fr_initial_config/.doctrees/environment.pickle differ diff --git a/fr_initial_config/_static/documentation_options.js b/fr_initial_config/_static/documentation_options.js index 654fb8b2..1981b87a 100644 --- a/fr_initial_config/_static/documentation_options.js +++ b/fr_initial_config/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0+untagged.1.g1d3fad9', + VERSION: '0+untagged.1.gcb77df9', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/fr_initial_config/developer/explanations/design-decisions.html b/fr_initial_config/developer/explanations/design-decisions.html index 0238ba00..31863d00 100644 --- a/fr_initial_config/developer/explanations/design-decisions.html +++ b/fr_initial_config/developer/explanations/design-decisions.html @@ -8,7 +8,7 @@ -
Update parameters from another IPCMessage.
+Updates parameters from another IPCMessage.
+Updates parameters from another IPCMessage.
This will iterate the parameters in the given IPCMessage and set them on this instance.
Updates parameters from a rapidJSON object.
+Updates parameters from a rapidJSON object.
+This method will update the parameters in message with the contents of the specified JSON object.
+param_val – - RapidJSON value object of parameters
param_prefix – - string prefix for parameter path to set
Sets the nack message type with a reason parameter.
Sets the message type to not acknowledged and sets an appropriate rejection message
-This method can be used to set this IpcMessage up as a rejection (nack) message. A reason is supplied and set as a parameter called ‘error’
+This method can be used to set this IpcMessage up as a rejection (nack) message. A reason is supplied and set as a parameter called ‘error’
+void
+Returns a JSON-encoded string of the message parameters at a specified path.
+Returns a JSON-encoded string of the message parameters at a specified path
+This method returns a JSON-encoded string version of the parameters associated with the message, or a subset of those at a specified slash-delimited path.
+param_path – - JSON pointer-like slash delimited path into the parameter block
+JSON encoded parameters as a null-terminated, string character array
+Copies parameters at a specified into the specified JSON value object.
+Copies parameters at a specified into the specified JSON value object
+This method copies the message parameters at the specified path into a JSON value object.
+param_obj – - reference to JSON value object to receive the parameters
param_path – - path of parameters in the message to copy
Private Functions
@@ -2417,6 +2471,7 @@IpcMessage::IpcMessage()
IpcMessage::IpcMessage()
IpcMessage::update()
IpcMessage::update()
IpcMessage::get_param()
IpcMessage::get_param()
IpcMessage::get_param_names()
IpcMessage::set_msg_val()
IpcMessage::set_msg_id()
IpcMessage::encode()
IpcMessage::encode_params()
IpcMessage::copy_params()
IpcMessage::internal_set_param()
IpcMessage::get_attribute()
IpcMessage::get_attribute()