www.gusucode.com > ros 工具箱 matlab源码程序 > ros/+robotics/+ros/+msggen/+wireless_msgs/Quality.m

    classdef Quality < robotics.ros.Message
    %Quality MATLAB implementation of wireless_msgs/Quality
    %   This class was automatically generated by
    %   robotics.ros.msg.internal.gen.MessageClassGenerator.
    
    %   Copyright 2014-2016 The MathWorks, Inc.
    
    %#ok<*INUSD>
    
    properties (Constant)
        MessageType = 'wireless_msgs/Quality' % The ROS message type
    end
    
    properties (Constant, Hidden)
        MD5Checksum = '5362dac71ff196cfe73d1dc68d4c58ed' % The MD5 Checksum of the message definition
    end
    
    properties (Access = protected)
        JavaMessage % The Java message object
    end
    
    properties (Constant, Access = protected)
        StdMsgsHeaderClass = robotics.ros.msg.internal.MessageFactory.getClassForType('std_msgs/Header') % Dispatch to MATLAB class for message type std_msgs/Header
    end
    
    properties (Dependent)
        Header
        MessagesReceived
        MessagesMissed
        TotalLength
        LatencyAvg
        MessageLengths
        LatencyMeasurements
    end
    
    properties (Access = protected)
        Cache = struct('Header', []) % The cache for fast data access
    end
    
    properties (Constant, Hidden)
        PropertyList = {'Header', 'LatencyAvg', 'LatencyMeasurements', 'MessageLengths', 'MessagesMissed', 'MessagesReceived', 'TotalLength'} % List of non-constant message properties
        ROSPropertyList = {'header', 'latency_avg', 'latency_measurements', 'message_lengths', 'messages_missed', 'messages_received', 'total_length'} % List of non-constant ROS message properties
    end
    
    methods
        function obj = Quality(msg)
            %Quality Construct the message object Quality
            import com.mathworks.toolbox.robotics.ros.message.MessageInfo;
            
            % Support default constructor
            if nargin == 0
                obj.JavaMessage = obj.createNewJavaMessage;
                return;
            end
            
            % Construct appropriate empty array
            if isempty(msg)
                obj = obj.empty(0,1);
                return;
            end
            
            % Make scalar construction fast
            if isscalar(msg)
                % Check for correct input class
                if ~MessageInfo.compareTypes(msg(1), obj.MessageType)
                    error(message('robotics:ros:message:NoTypeMatch', obj.MessageType, ...
                        char(MessageInfo.getType(msg(1))) ));
                end
                obj.JavaMessage = msg(1);
                return;
            end
            
            % Check that this is a vector of scalar messages. Since this
            % is an object array, use arrayfun to verify.
            if ~all(arrayfun(@isscalar, msg))
                error(message('robotics:ros:message:MessageArraySizeError'));
            end
            
            % Check that all messages in the array have the correct type
            if ~all(arrayfun(@(x) MessageInfo.compareTypes(x, obj.MessageType), msg))
                error(message('robotics:ros:message:NoTypeMatchArray', obj.MessageType));
            end
            
            % Construct array of objects if necessary
            objType = class(obj);
            for i = 1:length(msg)
                obj(i,1) = feval(objType, msg(i)); %#ok<AGROW>
            end
        end
        
        function header = get.Header(obj)
            %get.Header Get the value for property Header
            if isempty(obj.Cache.Header)
                obj.Cache.Header = feval(obj.StdMsgsHeaderClass, obj.JavaMessage.getHeader);
            end
            header = obj.Cache.Header;
        end
        
        function set.Header(obj, header)
            %set.Header Set the value for property Header
            validateattributes(header, {obj.StdMsgsHeaderClass}, {'nonempty', 'scalar'}, 'Quality', 'Header');
            
            obj.JavaMessage.setHeader(header.getJavaObject);
            
            % Update cache if necessary
            if ~isempty(obj.Cache.Header)
                obj.Cache.Header.setJavaObject(header.getJavaObject);
            end
        end
        
        function messagesreceived = get.MessagesReceived(obj)
            %get.MessagesReceived Get the value for property MessagesReceived
            messagesreceived = typecast(int16(obj.JavaMessage.getMessagesReceived), 'uint16');
        end
        
        function set.MessagesReceived(obj, messagesreceived)
            %set.MessagesReceived Set the value for property MessagesReceived
            validateattributes(messagesreceived, {'numeric'}, {'nonempty', 'scalar'}, 'Quality', 'MessagesReceived');
            
            obj.JavaMessage.setMessagesReceived(messagesreceived);
        end
        
        function messagesmissed = get.MessagesMissed(obj)
            %get.MessagesMissed Get the value for property MessagesMissed
            messagesmissed = typecast(int16(obj.JavaMessage.getMessagesMissed), 'uint16');
        end
        
        function set.MessagesMissed(obj, messagesmissed)
            %set.MessagesMissed Set the value for property MessagesMissed
            validateattributes(messagesmissed, {'numeric'}, {'nonempty', 'scalar'}, 'Quality', 'MessagesMissed');
            
            obj.JavaMessage.setMessagesMissed(messagesmissed);
        end
        
        function totallength = get.TotalLength(obj)
            %get.TotalLength Get the value for property TotalLength
            totallength = typecast(int32(obj.JavaMessage.getTotalLength), 'uint32');
        end
        
        function set.TotalLength(obj, totallength)
            %set.TotalLength Set the value for property TotalLength
            validateattributes(totallength, {'numeric'}, {'nonempty', 'scalar'}, 'Quality', 'TotalLength');
            
            obj.JavaMessage.setTotalLength(totallength);
        end
        
        function latencyavg = get.LatencyAvg(obj)
            %get.LatencyAvg Get the value for property LatencyAvg
            latencyavg = single(obj.JavaMessage.getLatencyAvg);
        end
        
        function set.LatencyAvg(obj, latencyavg)
            %set.LatencyAvg Set the value for property LatencyAvg
            validateattributes(latencyavg, {'numeric'}, {'nonempty', 'scalar'}, 'Quality', 'LatencyAvg');
            
            obj.JavaMessage.setLatencyAvg(latencyavg);
        end
        
        function messagelengths = get.MessageLengths(obj)
            %get.MessageLengths Get the value for property MessageLengths
            javaArray = obj.JavaMessage.getMessageLengths;
            array = obj.readJavaArray(javaArray, 'uint32');
            messagelengths = uint32(array);
        end
        
        function set.MessageLengths(obj, messagelengths)
            %set.MessageLengths Set the value for property MessageLengths
            if ~isvector(messagelengths) && isempty(messagelengths)
                % Allow empty [] input
                messagelengths = uint32.empty(0,1);
            end
            
            validateattributes(messagelengths, {'numeric'}, {'vector'}, 'Quality', 'MessageLengths');
            
            javaArray = obj.JavaMessage.getMessageLengths;
            array = obj.writeJavaArray(messagelengths, javaArray, 'uint32');
            obj.JavaMessage.setMessageLengths(array);
        end
        
        function latencymeasurements = get.LatencyMeasurements(obj)
            %get.LatencyMeasurements Get the value for property LatencyMeasurements
            javaArray = obj.JavaMessage.getLatencyMeasurements;
            array = obj.readJavaArray(javaArray, 'single');
            latencymeasurements = single(array);
        end
        
        function set.LatencyMeasurements(obj, latencymeasurements)
            %set.LatencyMeasurements Set the value for property LatencyMeasurements
            if ~isvector(latencymeasurements) && isempty(latencymeasurements)
                % Allow empty [] input
                latencymeasurements = single.empty(0,1);
            end
            
            validateattributes(latencymeasurements, {'numeric'}, {'vector'}, 'Quality', 'LatencyMeasurements');
            
            javaArray = obj.JavaMessage.getLatencyMeasurements;
            array = obj.writeJavaArray(latencymeasurements, javaArray, 'single');
            obj.JavaMessage.setLatencyMeasurements(array);
        end
    end
    
    methods (Access = protected)
        function resetCache(obj)
            %resetCache Resets any cached properties
            obj.Cache.Header = [];
        end
        
        function cpObj = copyElement(obj)
            %copyElement Implements deep copy behavior for message
            
            % Call default copy method for shallow copy
            cpObj = copyElement@robotics.ros.Message(obj);
            
            % Clear any existing cached properties
            cpObj.resetCache;
            
            % Create a new Java message object
            cpObj.JavaMessage = obj.createNewJavaMessage;
            
            % Iterate over all primitive properties
            cpObj.MessagesReceived = obj.MessagesReceived;
            cpObj.MessagesMissed = obj.MessagesMissed;
            cpObj.TotalLength = obj.TotalLength;
            cpObj.LatencyAvg = obj.LatencyAvg;
            cpObj.MessageLengths = obj.MessageLengths;
            cpObj.LatencyMeasurements = obj.LatencyMeasurements;
            
            % Recursively copy compound properties
            cpObj.Header = copy(obj.Header);
        end
        
        function reload(obj, strObj)
            %reload Called by loadobj to assign properties
            obj.MessagesReceived = strObj.MessagesReceived;
            obj.MessagesMissed = strObj.MessagesMissed;
            obj.TotalLength = strObj.TotalLength;
            obj.LatencyAvg = strObj.LatencyAvg;
            obj.MessageLengths = strObj.MessageLengths;
            obj.LatencyMeasurements = strObj.LatencyMeasurements;
            obj.Header = feval([obj.StdMsgsHeaderClass '.loadobj'], strObj.Header);
        end
    end
    
    methods (Access = ?robotics.ros.Message)
        function strObj = saveobj(obj)
            %saveobj Implements saving of message to MAT file
            
            % Return an empty element if object array is empty
            if isempty(obj)
                strObj = struct.empty;
                return
            end
            
            strObj.MessagesReceived = obj.MessagesReceived;
            strObj.MessagesMissed = obj.MessagesMissed;
            strObj.TotalLength = obj.TotalLength;
            strObj.LatencyAvg = obj.LatencyAvg;
            strObj.MessageLengths = obj.MessageLengths;
            strObj.LatencyMeasurements = obj.LatencyMeasurements;
            strObj.Header = saveobj(obj.Header);
        end
    end
    
    methods (Static, Access = {?matlab.unittest.TestCase, ?robotics.ros.Message})
        function obj = loadobj(strObj)
            %loadobj Implements loading of message from MAT file
            
            % Return an empty object array if the structure element is not defined
            if isempty(strObj)
                obj = robotics.ros.msggen.wireless_msgs.Quality.empty(0,1);
                return
            end
            
            % Create an empty message object
            obj = robotics.ros.msggen.wireless_msgs.Quality;
            obj.reload(strObj);
        end
    end
end