Skip to content

simple_calc (ndi.document class)

Class definition

Class name: ndi_calculation_simple_simple_calc
Short name: simple_calc
Superclasses: ndi_document, ndi_document_app

Definition: $NDIDOCUMENTPATH/apps/calculations/simple_calc.json
Schema for validation: $NDISCHEMAPATH/apps/calculations/simple_calc_schema.json
Property_list_name: simple
Class_version: 1

simple_calc fields

Accessed by simple.field where field is one of the field names below

field default_value data type description
input_parameters
answer

ndi_document fields

Accessed by ndi_document.field where field is one of the field names below

field default_value data type description
session_id - NDI ID string The globally unique identifier of any data session that produced this document
id - NDI ID string The globally unique identifier of this document
name character array (ASCII) A user-specified name, free for users/developers to use as they like
type character array (ASCII) A user-specified type, free for users/developers to use as they like (deprecated, will be removed)
datestamp (current time) ISO-8601 date string, time zone must be UTC leap seconds Time of document creation
database_version - character array (ASCII) Version of this document in the database

ndi_document_app fields

Accessed by app.field where field is one of the field names below

field default_value data type description
name ndi.app character array (ASCII) The name of the application
version - character array (ASCII) The version of the app according to the app's own version schedule; often this is a Git commit identifier
url URL as a character array (ASCII) The home page of the application
os character array (ASCII) The operating system that ran the application
os_version character array (ASCII) The operating system version
interpreter character array (ASCII) If applicable, the name of the interpreter (Matlab, python3, etc)
interpreter_version character array (ASCII) If applicable, the version of the interpreter