Support for complex types

CHANGELOG.md

@@ -1670,6 +1670,7 @@
   - Enabled selected public APIs
   - Basic example
   - Documentation for APIs (not final) 
+  - Enabled write_arb_waveform functions along with examples.
 - Changed
 - Removed
 
@@ -2140,7 +2141,6 @@
 - [0.2.0](#nise-020---2018-10-25)
 - [0.1.0](#nise-010---2018-10-17)
 
-#### [nise] Unreleased
 - Added
 - Changed
 - Removed
@@ -2296,7 +2296,6 @@
 - [0.3.0](#niswitch-030---2017-10-13)
 - [0.2.0](#niswitch-020---2017-09-20)
 
-#### [niswitch] Unreleased
 - Added
 - Changed
 - Removed
@@ -2547,7 +2546,6 @@
 - [0.3.0](#nitclk-030---2019-11-19)
 - [0.1.0](#nitclk-010---2019-10-21)
 
-#### [nitclk] Unreleased
 - Added
 - Changed
 - Removed

build/defines.mak

@@ -59,6 +59,7 @@ DEFAULT_PY_FILES_TO_GENERATE := \
     unit_tests/_matchers.py \
     __init__.py \
     _converters.py \
+    _complextype.py \
     VERSION \
     $(if $(GRPC_SUPPORTED), \
         _grpc_stub_interpreter.py \

build/helper/codegen_helper.py

@@ -256,6 +256,10 @@ def get_ctype_variable_declaration_snippet(parameter, parameters, ivi_dance_step
     else:
         module_name = '_visatype'
 
+    # Use _complextype.py file for complex parameter
+    if parameter['complex_type'] != 'none':
+        module_name = '_complextype'
+
     if parameter['is_string'] is True:
         definitions = _get_ctype_variable_definition_snippet_for_string(parameter, parameters, ivi_dance_step, module_name)
     elif parameter['is_buffer'] is True:
@@ -362,7 +366,12 @@ def _get_ctype_variable_definition_snippet_for_scalar(parameter, parameters, ivi
             definition = '{}.{}({})  # case S150'.format(module_name, parameter['ctypes_type'], parameter['python_name'])
         elif corresponding_buffer_parameters and corresponding_buffer_parameters[0]['direction'] == 'in':  # We are only looking at the first one to see if it is 'in'. Assumes all are the same here, assert below if not
             # Parameter denotes the size of another (the "corresponding") parameter.
-            definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}))  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
+
+            # Interleaved array length is going to be double the length of number of samples
+            if 'interleaved' in corresponding_buffer_parameters[0]['complex_type']:
+                definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}) // 2)  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
+            else:
+                definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}))  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
         else:
             if corresponding_buffer_parameters[0]['size']['mechanism'] == 'ivi-dance':  # We are only looking at the first one. Assumes all are the same here, assert below if not
                 # Verify all corresponding_buffer_parameters are 'out' and 'ivi-dance'
@@ -426,7 +435,10 @@ def _get_ctype_variable_definition_snippet_for_buffers(parameter, parameters, iv
     definition = None
 
     if parameter['numpy'] is True and use_numpy_array is True:
-        definition = '_get_ctypes_pointer_for_buffer(value={})  # case B510'.format(parameter['python_name'])
+        if parameter['complex_type'] == 'none':
+            definition = '_get_ctypes_pointer_for_buffer(value={})  # case B510'.format(parameter['python_name'])
+        else:
+            definition = '_get_ctypes_pointer_for_buffer(value={}, library_type={}.{})  # case B510'.format(parameter['python_name'], module_name, parameter['ctypes_type'])
     elif parameter['direction'] == 'in':
         if custom_type is not None:
             definition = '_get_ctypes_pointer_for_buffer([{0}.{1}(c) for c in {2}], library_type={0}.{1})  # case B540'.format(module_name, parameter['ctypes_type'], parameter['python_name'])

build/helper/helper.py

@@ -7,25 +7,28 @@
 
 # noqa statements because we want to format the table in a readable way
 _type_map = {
-    'ViConstString': { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViString':      { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViInt8':        { 'array_type': 'b',      'python_type': 'int',   'numpy_type': 'int8',       },  # noqa: E201, E202, E241
-    'ViUInt8':       { 'array_type': 'B',      'python_type': 'int',   'numpy_type': 'uint8',      },  # noqa: E201, E202, E241
-    'ViInt16':       { 'array_type': 'h',      'python_type': 'int',   'numpy_type': 'int16',      },  # noqa: E201, E202, E241
-    'ViUInt16':      { 'array_type': 'H',      'python_type': 'int',   'numpy_type': 'uint16',     },  # noqa: E201, E202, E241
-    'ViInt32':       { 'array_type': 'l',      'python_type': 'int',   'numpy_type': 'int32',      },  # noqa: E201, E202, E241
-    'ViUInt32':      { 'array_type': 'L',      'python_type': 'int',   'numpy_type': 'uint32',     },  # noqa: E201, E202, E241
-    'ViInt64':       { 'array_type': 'q',      'python_type': 'int',   'numpy_type': 'int64',      },  # noqa: E201, E202, E241
-    'ViUInt64':      { 'array_type': 'Q',      'python_type': 'int',   'numpy_type': 'uint64',     },  # noqa: E201, E202, E241
-    'ViReal32':      { 'array_type': 'f',      'python_type': 'float', 'numpy_type': 'float32',    },  # noqa: E201, E202, E241
-    'ViReal64':      { 'array_type': 'd',      'python_type': 'float', 'numpy_type': 'float64',    },  # noqa: E201, E202, E241
-    'ViStatus':      { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViSession':     { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViAttr':        { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViChar':        { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViChar[]':      { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViBoolean':     { 'array_type': None,     'python_type': 'bool',  'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViRsrc':        { 'array_type': None,     'python_type': 'str',   'numpy_type': 'bool_',      },  # noqa: E201, E202, E241
+    'ViConstString':    { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViString':         { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViInt8':           { 'array_type': 'b',      'python_type': 'int',   'numpy_type': 'int8',       },  # noqa: E201, E202, E241
+    'ViUInt8':          { 'array_type': 'B',      'python_type': 'int',   'numpy_type': 'uint8',      },  # noqa: E201, E202, E241
+    'ViInt16':          { 'array_type': 'h',      'python_type': 'int',   'numpy_type': 'int16',      },  # noqa: E201, E202, E241
+    'ViUInt16':         { 'array_type': 'H',      'python_type': 'int',   'numpy_type': 'uint16',     },  # noqa: E201, E202, E241
+    'ViInt32':          { 'array_type': 'l',      'python_type': 'int',   'numpy_type': 'int32',      },  # noqa: E201, E202, E241
+    'ViUInt32':         { 'array_type': 'L',      'python_type': 'int',   'numpy_type': 'uint32',     },  # noqa: E201, E202, E241
+    'ViInt64':          { 'array_type': 'q',      'python_type': 'int',   'numpy_type': 'int64',      },  # noqa: E201, E202, E241
+    'ViUInt64':         { 'array_type': 'Q',      'python_type': 'int',   'numpy_type': 'uint64',     },  # noqa: E201, E202, E241
+    'ViReal32':         { 'array_type': 'f',      'python_type': 'float', 'numpy_type': 'float32',    },  # noqa: E201, E202, E241
+    'ViReal64':         { 'array_type': 'd',      'python_type': 'float', 'numpy_type': 'float64',    },  # noqa: E201, E202, E241
+    'ViStatus':         { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViSession':        { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViAttr':           { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViChar':           { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViChar[]':         { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViBoolean':        { 'array_type': None,     'python_type': 'bool',  'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViRsrc':           { 'array_type': None,     'python_type': 'str',   'numpy_type': 'bool_',      },  # noqa: E201, E202, E241
+    'ComplexViReal64':  { 'array_type': None,     'python_type': None,    'numpy_type': 'complex128', },  # noqa: E201, E202, E241
+    'ComplexViReal32':  { 'array_type': None,     'python_type': None,    'numpy_type': 'complex64',  },  # noqa: E201, E202, E241
+    'ComplexViInt16':   { 'array_type': None,     'python_type': None,    'numpy_type': 'int16',      },  # noqa: E201, E202, E241
 }
 
 

build/helper/metadata_add_all.py

@@ -126,6 +126,12 @@ def _add_ctypes_type(parameter, config):
         parameter['ctypes_type_library_call'] = module_name + parameter['ctypes_type']
 
 
+def _add_complex_type(parameter):
+    '''Adds a complex_type parameter to the metadata for complex numbers'''
+    if 'complex_type' not in parameter:
+        parameter['complex_type'] = 'none'
+
+
 def _add_numpy_info(parameter, parameters, config):
     '''Adds the following numpy-related information:
 
@@ -450,6 +456,7 @@ def add_all_function_metadata(functions, config):
             _add_python_type(p, config)
             _add_ctypes_variable_name(p)
             _add_ctypes_type(p, config)
+            _add_complex_type(p)
             _add_numpy_info(p, functions[f]['parameters'], config)
             _add_default_value_name(p)
             _add_default_value_name_for_docs(p, config['module_name'])

build/templates/_complextype.py.mako

@@ -0,0 +1,21 @@
+${template_parameters['encoding_tag']}
+# This file was generated
+<%
+    import build.helper as helper
+    config = template_parameters['metadata'].config
+    module_name = config['module_name']
+%>\
+import ctypes
+import ${module_name}._visatype as _visatype
+
+
+class ComplexViReal64(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViReal64), ("imag", _visatype.ViReal64)]
+
+
+class ComplexViReal32(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViReal32), ("imag", _visatype.ViReal32)]
+
+
+class ComplexViInt16(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViInt16), ("imag", _visatype.ViInt16)]

build/templates/_library.py.mako

@@ -18,6 +18,7 @@ import ctypes
 import ${module_name}.errors as errors
 import threading
 
+from ${module_name}._complextype import *  # noqa: F401,F403,H303
 from ${module_name}._visatype import *  # noqa: F403,H303
 % for c in config['custom_types']:
 

build/templates/_library_interpreter.py.mako

@@ -21,6 +21,7 @@ import hightime  # noqa: F401
 import platform
 
 % endif
+import ${module_name}._complextype as _complextype  # noqa: F401
 import ${module_name}._library_singleton as _library_singleton
 import ${module_name}._visatype as _visatype
 % if config['enums']:
@@ -46,7 +47,12 @@ def _get_ctypes_pointer_for_buffer(value=None, library_type=None, size=None):
         return ctypes.cast(addr, ctypes.POINTER(library_type))
     elif str(type(value)).find("'numpy.ndarray'") != -1:
         import numpy
-        return numpy.ctypeslib.as_ctypes(value)
+        if library_type in (_complextype.ComplexViInt16, _complextype.ComplexViReal32, _complextype.ComplexViReal64):
+            complex_dtype = numpy.dtype(library_type)
+            structured_array = value.view(complex_dtype)
+            return structured_array.ctypes.data_as(ctypes.POINTER(library_type))
+        else:
+            return numpy.ctypeslib.as_ctypes(value)
     elif isinstance(value, bytes):
         return ctypes.cast(value, ctypes.POINTER(library_type))
     elif isinstance(value, list):

build/templates/_matchers.py.mako

@@ -5,6 +5,7 @@ These work well with our visatype definitions.
 '''
 
 import ctypes
+import ${template_parameters['metadata'].config['module_name']}._complextype as _complextype
 import ${template_parameters['metadata'].config['module_name']}._visatype as _visatype
 import pprint
 
@@ -271,6 +272,65 @@ class ViReal64PointerMatcher(_PointerMatcher):
         _PointerMatcher.__init__(self, _visatype.ViReal64)
 
 
+class ComplexViReal64PointerMatcher(_PointerMatcher):
+    def __init__(self, expected_data, expected_size):
+        _PointerMatcher.__init__(self, _complextype.ComplexViReal64)
+        self.expected_data = expected_data
+        self.expected_size = expected_size
+
+    def __eq__(self, other):
+        _PointerMatcher.__eq__(self, other)
+
+        for i in range(self.expected_size):
+            expected_value = self.expected_data[i]
+            actual_value = other[i]
+            if expected_value.real != actual_value.real or expected_value.imag != actual_value.imag:
+                return False
+        return True
+
+    def __repr__(self):
+        return f"ComplexViReal64PointerMatcher({self.expected_data})"
+
+
+class ComplexViReal32PointerMatcher(_PointerMatcher):
+    def __init__(self, expected_data, expected_size):
+        _PointerMatcher.__init__(self, _complextype.ComplexViReal32)
+        self.expected_data = expected_data
+        self.expected_size = expected_size
+
+    def __eq__(self, other):
+        _PointerMatcher.__eq__(self, other)
+
+        for i in range(self.expected_size):
+            expected_value = self.expected_data[i]
+            actual_value = other[i]
+            if expected_value.real != actual_value.real or expected_value.imag != actual_value.imag:
+                return False
+        return True
+
+    def __repr__(self):
+        return f"ComplexViReal32PointerMatcher({self.expected_data})"
+
+
+class ComplexViInt16PointerMatcher(_PointerMatcher):
+    def __init__(self, expected_data, expected_size):
+        _PointerMatcher.__init__(self, _complextype.ComplexViInt16)
+        self.expected_data = expected_data
+        self.expected_size = expected_size
+
+    def __eq__(self, other):
+        _PointerMatcher.__eq__(self, other)
+
+        for i in range(self.expected_size):
+            expected_value = self.expected_data[i]
+            actual_value = other[i]
+            if expected_value.real != actual_value.real or expected_value.imag != actual_value.imag:
+                return False
+        return True
+
+    def __repr__(self):
+        return f"ComplexViInt16PointerMatcher({self.expected_data})"
+
 # Buffers