Matlab-Prologix-scripts/OOequipment/subfiles/FunctionGeneratorClass.m

classdef FunctionGeneratorClass < EquipmentClass
%   FUNCTIONGENERATORCLASS Control a function generator.
%	fg = FUNCTIONGENERATORCLASS('IP', PORT, GPIB_CHAN) connects
%	to a function generator on IPv4 address 'IP', on port
%	'PORT' and GPIO channel 'GPIB_CHAN', using the Equipment
%	class.
%
%	See also EQUIPMENTCLASS, OSCILLOSCOPECLASS, DIGITALMULTIMETERCLASS.
    
    properties (Dependent)
		waveform %Waveform shape
		frequency %Frequency setting in hertz
		voltage %Amplitude setting as defined by FUNCTIONGENERATORCLASS.UNIT
		unit %unit of amplitude: VPP|VRMS|DBM|DEFault
		offset %Offset setting in volt
		load %output impedence setting 50|inf
        output %output enable setting. Only available on 332xx and newer.
    end
    
    methods
		function fg = FunctionGeneratorClass(ipAddress,port,channel)
			% FUNCTIONGENERATORCLASS Control a function generator.
			%	fg = FUNCTIONGENERATORCLASS('IP', PORT, GPIB_CHAN) connects
			%	to a function generator on IPv4 address 'IP', on port
			%	'PORT' and GPIO channel 'GPIB_CHAN', using the Equipment
			%	class.
			%
			%	See also EQUIPMENTCLASS, OSCILLOSCOPECLASS, DIGITALMULTIMETERCLASS.
			fg@EquipmentClass(ipAddress,port,channel);
            
		end

		function w = get.waveform(fg)
			%Get the function generator waveform setting on waveform
			% variable access, using the corresponding SCPI command.
			w = FunctionGeneratorClass.getWave(fg.query('FUNCtion:SHAPe?'));
		end
		
		function f = get.frequency(fg)
			%Get function generator frequency setting on frequency variable
			% access, using the corresponding SCPI command.
			f = str2num(fg.query('FREQuency?'));
		end
		
		function v = get.voltage(fg)
			%Get function generator output voltage setting on output
			% variable access, using the corresponding SCPI command.
			v = str2num(fg.query('VOLTage?'));
		end

		function u = get.unit(fg)
			%Get function generator output voltage unit setting on offset
			% variable access, using the corresponding SCPI command.
			u = FunctionGeneratorClass.getUnit(fg.query('VOLTage:UNIT?'));
		end

		function o = get.offset(fg)
			%Get function generator offset setting on offset variable
			% access, using the corresponding SCPI command.
			o = str2num(fg.query('VOLTage:OFFSet?'));
		end

		function l = get.load(fg)
			%Get function generator load setting on load variable
			% access, using the corresponding SCPI command.
			l = FunctionGeneratorClass.getLoad(fg.query('OUTPut:LOAD?'));
        end
        
        function out = get.output(fg)
            if strcmp(fg.model(1:3),'335') || strcmp(fg.model(1:3),'332')
                out = fg.query('OUTP?');
            else
                warning('This generator does not support this function');
            end
        end

		function fg = set.waveform(fg,w)
			%Set function generator waveform setting on waveform variable
			% access, using the corresponding SCPI command.
			fg.write(['FUNCtion:SHAPe ' FunctionGeneratorClass.getWave(w)]);
		end

		function fg = set.frequency(fg,f)
			%Set function generator frequency setting on frequency variable
			% access, using the corresponding SCPI command.
			Equipment.forceNum(f);
			fg.write(['FREQuency ' num2str(f)]);
		end

		function fg = set.voltage(fg,v)
			%Set function generator output voltage on voltage variable
			% access, using the corresponding SCPI command.
			Equipment.forceNum(v);
			fg.write(['VOLTage ' num2str(v)]);
		end

		function fg = set.unit(fg,u)
			%Set function generator output voltage unit setting on unit
			% variable access, using the corresponding SCPI command.
			fg.write(['VOLTage:UNIT ' FunctionGeneratorClass.getUnit(u)]);
		end

		function fg = set.offset(fg,o)
			%Set function generator offset setting on offset variable access,
			% using the corresponding SCPI command.
			Equipment.forceNum(o);
			fg.write(['VOLTage:OFFSet ' num2str(o)]);
		end

		function fg = set.load(fg,l)
			%Set function generator load setting on load variable access,
			% using the corresponding SCPI command.
			fg.write(['OUTPut:LOAD ' FunctionGeneratorClass.getLoad(l)]);
        end
        
        function fg = set.output(fg,out)
            if strcmp(fg.model(1:3),'335') || strcmp(fg.model(1:3),'332')
                fg.write(['OUTP ' EquipmentClass.optionnum2str(out)])
            end
        end
        
        function downloadwaveform(fg,waveform,name)
            switch fg.model
                case '33120A'
                    downloadwaveform_legacy(fg,waveform,name);
                otherwise
                    downloadwaveform_new(fg,waveform,name);
            end
        end
        
        function downloadwaveform_legacy(fg,waveform,name)
            name_trunc = name(1:min(length(name),8));
            fg.opc;
            fg.write_noerror(['data volatile' num2str(waveform,',%0.4f')]);
            fg.opc;
            fg.error;
            fg.write_noerror(['data:copy ' name_trunc]);
            fg.opc;
            fg.error;
            fg.write(['func:user' name_trunc]);
        end
        
        function downloadwaveform_new(fg,waveform,name)
            fg.disableEOI;
            fg.write_unsafe(['data:arb ' name ',']);
            fg.enableEOI;
            binblockwrite(fg.tcp,waveform,'float')
            fg.error;
            fg.write(['func:arb ' name])
            fg.write(['MMEM:STORE:DATA "INT:\' name '.arb"'])
        end
        
        function scintilla(fg,periods)
            periods = round(periods);
            x = linspace(-periods*pi,periods*pi,1600);
            y = exp(-abs(x./6)).*sin(x)./0.8;
            fg.downloadwaveform(y,'scintilla');
        end
    end

	methods (Static)
		function w = getWave(win)
			%GETWAVE Returns the waveform ('sinusoid', 'square', 'triangle',
			% 'ramp', 'noise', 'dc', 'user', 'minimum' or 'maximum') from
			% function generator output or (possibly malformed) user input.

			%Match two letter inputs first, single letters or single numbers
			% second. 's' is a special case (case sensitive for sine or Square).
			% Longer inputs are matched and reduced to two letters.
			w = regexp(num2str(win), '(si|sq|mi|ma|[trndu1-7]|s)', 'match', 'once', 'ignorecase');

			%Error if not matched.
			if isempty(w)
				error(['Invalid waveform: ' win]);
			end

			%Replace two letter, single letter or single number by correct
			% waveform.
			w = regexprep(w, {'^(1|si|(?-i)s)$', '^(2|sq|(?-i)S)$', '^[3t]$', '^[4r]$', '^[5n]$', '^[6d]$', '^[7u]$', '^mi$', '^ma$'}, ...
                {'sinusoid', 'square', 'triangle', 'ramp', 'noise', 'dc', 'user', 'minimum', 'maximum'}, 'ignorecase');
		end

		function u = getUnit(uin)
			%GETUNIT Returns the unit ('Vpp', 'Vrms', 'dBm' or 'default')
			% from function generator output or (possibly malformed) user
			% input.

			%Match correct single number or double letter inputs.
			% Longer inputs are matched and reduced to two letters.
			u = regexp(num2str(uin), '([1-4]|vp|vr|db|de)', 'match', 'once', 'ignorecase');

			%Error if not matched.
			if isempty(u)
				error(['Invalid voltage unit: ' uin]);
			end

			%Replace two letter or single number by correct unit.
			u = regexprep(u, {'^(1|vp)$', '^(2|vr)$', '^(3|db)$', '^(4|de)$'}, ...
                {'Vpp', 'Vrms', 'dBm', 'default'}, 'ignorecase');
		end

		function u = getLoad(lin)
			%GETLOAD Returns the load setting ('50', 'infinity', 'minimum',
			% or 'maximum') from function generator output or
			% (possibly malformed) user input.

			%Match correct number or double letter inputs.
			% Longer inputs are matched and reduced to two letters.
			l = regexp(num2str(lin), '([12]|50|in|mi|ma)', 'match', 'once', 'ignorecase');

			%Error if not matched.
			if isempty(l)
				error(['Invalid load: "' lin '".']);
			end

			%Replace two letter or single number by correct load setting.
			u = regexprep(l, {'^(1|50)$', '^(2|in)$', '^mi$', '^ma$'}, ...
                {'50', 'infinity', 'minimum', 'maximum'}, 'ignorecase');
		end
	end
    
end