Add additional metadata to NIDAQmx errors

generated/nidaqmx/nidaqmx_service.h

@@ -435,6 +435,8 @@ class NiDAQmxService final : public NiDAQmx::WithCallbackMethod_RegisterSignalEv
   NiDAQmxLibraryInterface* library_;
   ResourceRepositorySharedPtr session_repository_;
   ::grpc::Status ConvertApiErrorStatusForTaskHandle(::grpc::ServerContext* context, int32_t status, TaskHandle task);
+  ::grpc::Status ConvertApiErrorStatusWithReadParametersForTaskHandle(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_read, TaskHandle task);
+  ::grpc::Status ConvertApiErrorStatusWithWriteParametersForTaskHandle(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_written, TaskHandle task);
 
   NiDAQmxFeatureToggles feature_toggles_;
 };

source/codegen/common_helpers.py

@@ -22,6 +22,14 @@
     PascalTokenSubstitution("Uint", "UInt")
 ]
 
+READ_ERROR_PARAMETERS = [
+    "samps_read", "samps_per_chan_read"
+]
+
+WRITE_ERROR_PARAMETERS = [
+    "samps_per_chan_written", "num_samps_per_chan", "num_samps_per_chan_written"
+]
+
 
 def is_output_parameter(parameter):
     """Whether the parameter is an output parameter."""
@@ -1186,3 +1194,13 @@ def get_params_needing_initialization(parameters: List[dict]) -> List[dict]:
     * Outputs that are calculated/populated after the API call.
     """
     return [p for p in parameters if not (is_return_value(p) or is_get_last_error_output_param(p))]
+
+
+def get_parameter_for_error_generation(params, is_read_method):
+    for param in params:
+        if param["direction"] == "out":
+            if is_read_method and _camel_to_snake(param["name"]) in READ_ERROR_PARAMETERS:
+                return _camel_to_snake(param["name"])
+            elif not is_read_method and _camel_to_snake(param["name"]) in WRITE_ERROR_PARAMETERS:
+                return _camel_to_snake(param["name"])
+    return None

source/codegen/metadata/nidaqmx/__init__.py

@@ -1,12 +1,20 @@
 from .functions import functions
-from .functions_addon import functions_validation_suppressions
+from .functions_addon import functions_validation_suppressions, functions_override_metadata
 from .attributes import attributes
 from .enums import enums
 from .enums_addon import enums_validation_suppressions
 from .config import config
 
+copy_functions = functions.copy()
+def update_functions():
+    for function_name, function_data in functions_override_metadata.items():
+        copy_functions[function_name] = {**copy_functions[function_name], **functions_override_metadata[function_name]}
+    return copy_functions
+
+all_functions = update_functions() 
+
 metadata = {
-    "functions" : functions,
+    "functions" : all_functions,
     "functions_validation_suppressions": functions_validation_suppressions,
     "attributes" : attributes,
     "enums" : enums,

source/codegen/metadata/nidaqmx/functions_addon.py

@@ -1,4 +1,139 @@
 functions_override_metadata = {
+    'ReadAnalogF64': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadAnalogScalarF64': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadBinaryI16': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadBinaryI32': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadBinaryU16': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadBinaryU32': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCounterF64': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCounterF64Ex': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCounterScalarF64': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadCounterScalarU32': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadCounterU32': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCounterU32Ex': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCtrFreq': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCtrFreqScalar': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadCtrTicks': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCtrTicksScalar': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadCtrTime': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadCtrTimeScalar': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadDigitalLines': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadDigitalScalarU32': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'ReadDigitalU16': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadDigitalU32': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadDigitalU8': {
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadPowerScalarF64': {
+        'python_codegen_method': 'CustomCode_Read_Scalar',
+    },
+    'WriteAnalogF64': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteAnalogScalarF64': {
+        'python_codegen_method': 'CustomCode_Write_Scalar',
+    },
+    'WriteBinaryI16': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteBinaryI32': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteBinaryU16': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteBinaryU32': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteCtrFreq': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteCtrFreqScalar': {
+        'python_codegen_method': 'CustomCode_Write_Scalar',
+    },
+    'WriteCtrTicks': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteCtrTicksScalar': {
+        'python_codegen_method': 'CustomCode_Write_Scalar',
+    },
+    'WriteCtrTime': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteCtrTimeScalar': {
+        'python_codegen_method': 'CustomCode_Write_Scalar',
+    },
+    'WriteDigitalLines': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteDigitalScalarU32': {
+        'python_codegen_method': 'CustomCode_Write_Scalar',
+    },
+    'WriteDigitalU16': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteDigitalU32': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'WriteDigitalU8': {
+        'python_codegen_method': 'CustomCode_Write',
+    },
+    'ReadPowerBinaryI16':{
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadPowerF64':{
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'ReadRaw':{
+        'python_codegen_method': 'CustomCode_Read',
+    },
+    'WriteRaw':{
+        'python_codegen_method': 'CustomCode_Write',
+    }
 }
 
 functions_validation_suppressions = {

source/codegen/metadata_validation.py

@@ -169,6 +169,7 @@ class RULES:
         Optional("adaptor_parameter"): dict,
         Optional("is_python_factory"): bool,
         Optional("python_description"): str,
+        Optional("python_codegen_method"): str,
     }
 )
 

source/codegen/templates/service.h.mako

@@ -101,6 +101,10 @@ private:
   cpp_handle_type = resource_handle_type[0].upper() + resource_handle_type[1:]
 %>\
   ::grpc::Status ConvertApiErrorStatusFor${cpp_handle_type}(::grpc::ServerContext* context, int32_t status, ${resource_handle_type} ${config["session_handle_parameter_name"]});
+  % if config["c_function_prefix"] == "DAQmx":
+  ::grpc::Status ConvertApiErrorStatusWithReadParametersFor${cpp_handle_type}(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_read, ${resource_handle_type} ${config["session_handle_parameter_name"]});
+  ::grpc::Status ConvertApiErrorStatusWithWriteParametersFor${cpp_handle_type}(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_written, ${resource_handle_type} ${config["session_handle_parameter_name"]});
+  %endif
 % endfor
 % if common_helpers.has_viboolean_array_param(functions):
   void Copy(const std::vector<ViBoolean>& input, google::protobuf::RepeatedField<bool>* output);

source/codegen/templates/service_helpers.mako

@@ -756,6 +756,7 @@ ${set_response_values(normal_outputs, init_method)}\
   config = data['config']
   input_parameters = [p for p in parameters if common_helpers.is_input_parameter(p)]
   resource_handle_types = service_helpers.get_resource_handle_types(config)
+  method_type = function_data.get("python_codegen_method", None)
 %>\
 <%block filter="common_helpers.indent(indent_level)">\
 <%
@@ -768,7 +769,11 @@ ${set_response_values(normal_outputs, init_method)}\
       break
   cpp_handle_type = handle_type[0].upper() + handle_type[1:]
   method_call = ""
-  if function_data.get('exclude_from_get_last_error', False):
+  if method_type == "CustomCode_Read":
+    method_call = f'return ConvertApiErrorStatusWithReadParametersFor{cpp_handle_type}(context, status, {common_helpers.get_parameter_for_error_generation(parameters, True)}, {session});'
+  elif method_type == "CustomCode_Write":
+    method_call = f'return ConvertApiErrorStatusWithWriteParametersFor{cpp_handle_type}(context, status, {common_helpers.get_parameter_for_error_generation(parameters, False)}, {session});'
+  elif function_data.get('exclude_from_get_last_error', False):
     method_call = f'return nidevice_grpc::ApiErrorToStatus(context, status);'
   else:
     method_call = f'return ConvertApiErrorStatusFor{cpp_handle_type}(context, status, {session});'

source/custom/nidaqmx_service.custom.cpp

@@ -10,4 +10,16 @@ ::grpc::Status NiDAQmxService::ConvertApiErrorStatusForTaskHandle(::grpc::Server
   return nidevice_grpc::ApiErrorAndDescriptionToStatus(context, status, description);
 }
 
+::grpc::Status NiDAQmxService::ConvertApiErrorStatusWithReadParametersForTaskHandle(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_read , TaskHandle task)
+{
+  context->AddTrailingMetadata("ni-samps-per-chan-read", std::to_string(samps_per_chan_read));
+  return ConvertApiErrorStatusForTaskHandle(context, status, task);
+}
+
+::grpc::Status NiDAQmxService::ConvertApiErrorStatusWithWriteParametersForTaskHandle(::grpc::ServerContext* context, int32_t status, int32_t samps_per_chan_written , TaskHandle task)
+{
+  context->AddTrailingMetadata("ni-samps-per-chan-written", std::to_string(samps_per_chan_written));
+  return ConvertApiErrorStatusForTaskHandle(context, status, task);
+}
+
 }  // namespace nidaqmx_grpc