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

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

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

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

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

Класс TensileData

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

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

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 Объекты

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

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

The 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

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

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

The 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 функция. The 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