Документация

Объекты как структуры данных

В этом примере определяется класс для хранения данных с определенной структурой. Использование согласованной структуры для хранения данных упрощает создание функций, работающих с данными. A MATLAB ®struct с именами полей, описывающими конкретный элемент данных, является полезным способом организации данных. Однако класс может определять как хранилище данных (свойства), так и операции, которые можно выполнять с этими данными (методами). Этот пример иллюстрирует эти преимущества.

Структура данных

В этой таблице описывается структура данных.

Класс TensableData

Этот пример начинается с простой реализации класса и строится на этой реализации для иллюстрации того, как функции повышают полезность класса.

Первая версия класса обеспечивает только хранение данных. Класс определяет свойство для каждого из требуемых элементов данных.

classdef TensileData
   properties
      Material
      SampleNumber
      Stress
      Strain
      Modulus
   end
end

Создание экземпляра и назначение данных

Следующие инструкции создают TensileData объект и присвойте ему данные:

td = TensileData;
td.Material = 'Carbon Steel';
td.SampleNumber = 001;
td.Stress = [2e4 4e4 6e4 8e4];
td.Strain = [.12 .20 .31 .40];
td.Modulus = mean(td.Stress./td.Strain);

Ограничить свойства определенными значениями

Ограничьте свойства определенными значениями, определив метод доступа к набору свойств. MATLAB вызывает метод доступа set всякий раз, когда задается значение свойства.

classdef TensileData
   properties
      Material
      SampleNumber
      Stress
      Strain
      Modulus
   end
   methods
      function obj = set.Material(obj,material)
         if (strcmpi(material,'aluminum') ||...
               strcmpi(material,'stainless steel') ||...
               strcmpi(material,'carbon steel'))
            obj.Material = material;
         else
            error('Invalid Material')
         end
      end
   end
end

td = TensileData;
td.Material = 'brass';

Error using TensileData/set.Material
Invalid Material

Упрощение интерфейса с помощью конструктора

Упрощение интерфейса с TensileData путем добавления конструктора, который:

Конструктор - это метод, имя которого совпадает с именем класса.

methods
   function td = TensileData(material,samplenum,stress,strain)
      if nargin > 0
         td.Material = material;
         td.SampleNumber = samplenum;
         td.Stress = stress;
         td.Strain = strain;
      end
   end 
end

Создать TensileData объект полностью заполнен данными с помощью следующей инструкции:

td = TensileData('carbon steel',1,...
      [2e4 4e4 6e4 8e4],...
      [.12 .20 .31 .40]);

Расчет данных по требованию

Если значение свойства зависит от значений других свойств, определите это свойство с помощью Dependent атрибут. MATLAB не сохраняет значения зависимых свойств. Метод получения зависимого свойства определяет значение свойства при обращении к свойству. Доступ может происходить при отображении свойств объекта или в результате явного запроса.

properties (Dependent)
   Modulus
end

methods
   function modulus = get.Modulus(obj)
      ind = find(obj.Strain > 0);
      modulus = mean(obj.Stress(ind)./obj.Strain(ind));
   end
end

td = TensileData('carbon steel',1,...
      [2e4 4e4 6e4 8e4],...
      [.12 .20 .31 .40]);
td.Modulus

ans =
  1.9005e+005

methods
   function obj = set.Modulus(obj,~)
      fprintf('%s%d\n','Modulus is: ',obj.Modulus)
      error('You cannot set the Modulus property');
   end
end

Показ TensileData Объекты

TensileData класс перегружает disp способ. Этот метод управляет отображением объектов в окне команд.

disp отображает значение Material, SampleNumber, и Modulus свойства. Он не отображает Stress и Strain данные свойств. Эти свойства содержат необработанные данные, которые нелегко просмотреть в окне команд.

disp метод использует fprintf для отображения форматированного текста в окне команд:

methods
   function disp(td)
      fprintf(1,...
         'Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
         td.Material,td.SampleNumber,td.Modulus);
   end 
end

Метод построения графика зависимости напряжения от деформации

Полезно просмотреть график данных напряжения/деформации, чтобы определить поведение материала в диапазоне приложенного натяжения. TensileData класс перегружает MATLAB plot функция.

plot метод создает линейный график данных зависимости напряжения от деформации и добавляет заголовок и метки оси для создания стандартизированного графика для записей данных растяжения:

methods
   function plot(td,varargin)
      plot(td.Strain,td.Stress,varargin{:})
      title(['Stress/Strain plot for Sample',...
         num2str(td.SampleNumber)])
      ylabel('Stress (psi)')
      xlabel('Strain %')
   end 
end

Первым аргументом этого метода является TensileData , который содержит данные.

Метод передает переменный список аргументов (varargin) непосредственно к встроенному plot функция. TensileData plot метод позволяет передавать аргументы спецификатора строки или пары имя-значение свойства.

Например:

td = TensileData('carbon steel',1,...
      [2e4 4e4 6e4 8e4],[.12 .20 .31 .40]);
plot(td,'-+b','LineWidth',2)

TensileData Синопсис класса

classdef TensileData

   properties
      Material
      SampleNumber
      Stress
      Strain
   end

   properties (Dependent)
      Modulus
   end 

   methods

   function td = TensileData(material,samplenum,...
      stress,strain)
      if nargin > 0
         td.Material = material;
         td.SampleNumber = samplenum;
         td.Stress = stress;
         td.Strain = strain;
      end
   end

   function obj = set.Material(obj,material)
      if (strcmpi(material,'aluminum') ||...
         strcmpi(material,'stainless steel') ||...
         strcmpi(material,'carbon steel'))
         obj.Material = material;
      else
         error('Invalid Material')
      end
   end

   function m = get.Modulus(obj)
      ind = find(obj.Strain > 0); 
      m = mean(obj.Stress(ind)./obj.Strain(ind)); 
   end 

   function obj = set.Modulus(obj,~)
      fprintf('%s%d\n','Modulus is: ',obj.Modulus)
      error('You cannot set Modulus property'); 
   end 

   function disp(td)
      fprintf(1,'Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
      td.Material,td.SampleNumber,td.Modulus)
   end 

   function plot(td,varargin)
      plot(td.Strain,td.Stress,varargin{:})
      title(['Stress/Strain plot for Sample',...
         num2str(td.SampleNumber)])
      ylabel('Stress (psi)')
      xlabel('Strain %')
   end 

   end
end

 Развернуть для кода класса

classdef TensileData
   properties
      Material
      SampleNumber
      Stress
      Strain
   end
   properties (Dependent)
      Modulus
   end
   
   methods
      function td = TensileData(material,samplenum,stress,strain)
         if nargin > 0
            td.Material = material;
            td.SampleNumber = samplenum;
            td.Stress = stress;
            td.Strain = strain;
         end
      end
      
      function obj = set.Material(obj,material)
         if (strcmpi(material,'aluminum') ||...
               strcmpi(material,'stainless steel') ||...
               strcmpi(material,'carbon steel'))
            obj.Material = material;
         else
            error('Invalid Material')
         end
      end
      
      function m = get.Modulus(obj)
         ind = find(obj.Strain > 0);
         m = mean(obj.Stress(ind)./obj.Strain(ind));
      end
      
      function obj = set.Modulus(obj,~)
         fprintf('%s%d\n','Modulus is: ',obj.Modulus)
         error('You cannot set Modulus property');
      end
      
      function disp(td)
         sprintf('Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
            td.Material,td.SampleNumber,td.Modulus)
      end
      
      function plot(td,varargin)
         plot(td.Strain,td.Stress,varargin{:})
         title(['Stress/Strain plot for Sample ',...
            num2str(td.SampleNumber)])
         xlabel('Strain %')
         ylabel('Stress (psi)')
      end
   end
end