Generated documentation.

Signed-off-by: Rule Timothy (VM/EMT3) <[email protected]>

doc/content/apis/modelc/examples/gateway.c

@@ -60,8 +60,8 @@ int main(int argc, char** argv)
                     char buffer[100];
                     snprintf(buffer, sizeof(buffer), "st=%f,index=%d",
                         model_time, i);
-                    sv->reset(sv, i);
-                    sv->append(sv, i, buffer, strlen(buffer) + 1);
+                    signal_reset(sv, i);
+                    signal_append(sv, i, buffer, strlen(buffer) + 1);
                 }
             } else {
                 /* Scalar vector. */

doc/content/apis/modelc/examples/signalvector_annotation.c

@@ -7,7 +7,7 @@ ModelDesc* model_create(ModelDesc* m)
 
     if (idx.scalar) {
         /* Set initial value. */
-        const char* v = idx.sv->annotation(idx.sv, idx.signal, "initial_value");
+        const char* v = signal_annotation(idx.sv, idx.signal, "initial_value");
         if (v) *(idx.scalar) = atoi(v);
     }
 

doc/content/apis/modelc/examples/signalvector_interface.c

@@ -19,11 +19,11 @@ int model_step(ModelDesc* m, double* model_time, double stop_time)
 
                 // Example use of object functions.
                 void* data = strdup("foo");
-                sv->reset(sv, i);
-                sv->append(sv, i, data, strlen("foo"));
+                signal_reset(sv, i);
+                signal_append(sv, i, data, strlen("foo"));
                 free(data);
-                sv->release(sv, i);
-                const char* mime_type = sv->annotation(sv, i, "mime_type");
+                signal_release(sv, i);
+                const char* mime_type = signal_annotation(sv, i, "mime_type");
                 if (mime_type) log_debug("    annotation : %s", mime_type);
             } else {
                 log_debug("  scalar : %s", sv->scalar[i]);

doc/content/apis/modelc/gateway/index.md

@@ -65,6 +65,7 @@ typedef struct ModelGatewayDesc {
     const char** argv;
     char* name_arg;
     double clock_epsilon;
+    uint64_t [4] __reserved__;
 }
 ```
 

doc/content/apis/modelc/model/index.md

@@ -99,11 +99,12 @@ center footer Dynamic Simulation Environment
 
 ```c
 typedef struct ModelDesc {
-    ModelVTable vtable;
     ModelIndex index;
     SimulationSpec* sim;
     ModelInstanceSpec* mi;
     SignalVector* sv;
+    ModelVTable vtable;
+    uint64_t [2] __reserved__;
 }
 ```
 
@@ -127,6 +128,7 @@ typedef struct ModelVTable {
     ModelStep step;
     ModelDestroy destroy;
     ModelIndex index;
+    void *[2] __reserved__;
 }
 ```
 
@@ -137,17 +139,13 @@ typedef struct SignalVector {
     const char* name;
     const char* alias;
     const char* function_name;
-    _Bool is_binary;
-    uint32_t count;
-    const char** signal;
-    BinarySignalAppendFunc append;
-    BinarySignalResetFunc reset;
-    BinarySignalReleaseFunc release;
-    SignalAnnotationGetFunc annotation;
-    BinarySignalCodecFunc codec;
     ModelInstanceSpec* mi;
     void* index;
-    SignalGroupAnnotationGetFunc group_annotation;
+    uint32_t count;
+    const char** signal;
+    _Bool is_binary;
+    SignalVectorVTable vtable;
+    uint64_t [9] __reserved__;
 }
 ```
 
@@ -161,6 +159,7 @@ typedef struct SignalVectorVTable {
     SignalAnnotationGetFunc annotation;
     BinarySignalCodecFunc codec;
     SignalGroupAnnotationGetFunc group_annotation;
+    void *[2] __reserved__;
 }
 ```
 
@@ -356,6 +355,10 @@ name (const char*)
 const char*
 : The annotation value.
 
+NULL
+: The requested annotation was not found, inspect `errno` for additional
+information..
+
 #### Example (Annotation Specification)
 
 
@@ -377,10 +380,6 @@ spec:
 >}}
 
 
-NULL
-: The requested annotation was not found.
-
-
 
 ### signal_append
 
@@ -406,6 +405,12 @@ len (uint32_t)
 0
 : The operation completed without error.
 
+-EINVAL (-22)
+: Bad arguments.
+
+-ENOSYS (-88)
+: The called function is not available.
+
 <>0
 : Indicates an error condition. Inspect `errno` for additional information.
 
@@ -432,7 +437,8 @@ void*
 : The Codec object associated with the binary signal.
 
 NULL
-: The binary signal does not have an associated Codec object.
+: The binary signal does not have an associated Codec object, inspect `errno`
+for additional information..
 
 #### Example (Codec Specification)
 
@@ -462,6 +468,29 @@ API](https://github.com/boschglobal/dse.standards/tree/main/dse/ncodec)
 
 
 
+### signal_group_annotation
+
+Get an annotation from a signal group.
+
+#### Parameters
+
+sv (SignalVector*)
+: The Signal Vector object representing the signal group.
+
+name (const char*)
+: The name of the annotation.
+
+#### Returns
+
+const char*
+: The annotation value.
+
+NULL
+: The requested annotation was not found, inspect `errno` for additional
+information..
+
+
+
 ### signal_release
 
 Release the resources allocated to a binary signal (e.g. free the buffer).
@@ -479,6 +508,12 @@ index (uint32_t)
 0
 : The operation completed without error.
 
+-EINVAL (-22)
+: Bad arguments.
+
+-ENOSYS (-88)
+: The called function is not available.
+
 <>0
 : Indicates an error condition. Inspect `errno` for additional information.
 
@@ -502,6 +537,12 @@ index (uint32_t)
 0
 : The operation completed without error.
 
+-EINVAL (-22)
+: Bad arguments.
+
+-ENOSYS (-88)
+: The called function is not available.
+
 <>0
 : Indicates an error condition. Inspect `errno` for additional information.
 

doc/content/apis/modelc/runtime/index.md

@@ -46,23 +46,6 @@ typedef struct ModelCArguments {
 }
 ```
 
-### ModelChannelDesc
-
-```c
-typedef struct ModelChannelDesc {
-    const char* name;
-    const char* function_name;
-    const char** signal_names;
-    int signal_count;
-    int propagator_source_channel;
-    int propagator_target_channel;
-    double* vector_double;
-    void** vector_binary;
-    int* vector_binary_size;
-    int* vector_binary_buffer_size;
-}
-```
-
 ### ModelDefinitionSpec
 
 ```c
@@ -87,6 +70,7 @@ typedef struct ModelInstanceSpec {
     void* spec;
     void* yaml_doc_list;
     void* private;
+    int [4] __reserved__;
 }
 ```
 

doc/content/docs/examples/modelc/ncodec/ncodec_config.c

@@ -5,7 +5,7 @@
 
 void configure_codec(ModelDesc* m, SignalVector* sv, uint32_t idx)
 {
-    NCODEC* nc = sv->codec(sv, idx);
+    NCODEC* nc = sv->vtable.codec(sv, idx);
     const char* node_id = NULL;
     for (int i = 0; i >= 0; i++) {
         NCodecConfigItem nci = ncodec_stat(nc, &i);

doc/content/docs/examples/modelc/ncodec/ncodec_test.c

@@ -37,7 +37,7 @@ void test_message_sequence(void** state)
 {
     ModelCMock*   mock = *state;
     SignalVector* sv = mock->mi->model_desc->sv;
-    NCODEC*       nc = sv->codec(sv, 2);
+    NCODEC*       nc = sv->vtable.codec(sv, 2);
     const char*   buffer = "hello world";
 
     // ...