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

Формулировка класса

Этот пример обсуждает, как приблизиться к разработке и реализации класса. Цель этого класса состоит в том, чтобы представлять знакомую концепцию (банковский счет). Однако можно применить тот же подход к большинству проектов класса.

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

Необходимо выполнить определенные операции на банковском счете:

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

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

Эти функции задают требования классов AccountManager и BankAccount. Включайте только, какая функциональность требуется, чтобы достигать ваших определенных целей. Поддержите специальные типы учетных записей путем разделения на подклассы BankAccount и добавления более определенных опций к подклассам. Расширьте AccountManager как требуется, чтобы поддержать новые типы учетных записей.

Определение компонентов класса

Классы хранят данные в свойствах, реализуют операции с методами и поддерживают уведомления с событиями и прослушивателями. Вот то, как BankAccount и классы AccountManager задают эти компоненты.

Реализация класса BankAccount

Важно гарантировать, что существует только один набор данных, сопоставленных с любым объектом класса BankAccount. Вы не хотели бы независимые копии объекта, который мог иметь, например, различные значения для остатка на счете. Поэтому реализуйте класс BankAccount как класс Handle. Все копии данного объекта указателя относятся к тем же данным.

classdef BankAccount < handle

   properties (Access = ?AccountManager)
        AccountStatus = 'open'
   end

   properties (SetAccess = private)
      AccountNumber
      AccountBalance
   end
   properties (Transient)
      AccountListener
   end

   events
      InsufficientFunds
   end

   methods

      function BA = BankAccount(AccountNumber,InitialBalance)
         BA.AccountNumber = AccountNumber;
         BA.AccountBalance = InitialBalance;
         BA.AccountListener = AccountManager.addAccount(BA);
      end

      function deposit(BA,amt)
         BA.AccountBalance = BA.AccountBalance + amt;
         if BA.AccountBalance > 0
            BA.AccountStatus = 'open';
         end
      end

      function withdraw(BA,amt)
         if (strcmp(BA.AccountStatus,'closed')&& ...
            BA.AccountBalance < 0)
            disp(['Account ',num2str(BA.AccountNumber),...
               ' has been closed.'])
            return
         end
         newbal = BA.AccountBalance - amt;
         BA.AccountBalance = newbal;
         if newbal < 0
            notify(BA,'InsufficientFunds')
         end
      end

      function getStatement(BA)
         disp('-------------------------')
         disp(['Account: ',num2str(BA.AccountNumber)])
         ab = sprintf('%0.2f',BA.AccountBalance);
         disp(['CurrentBalance: ',ab])
         disp(['Account Status: ',BA.AccountStatus])
         disp('-------------------------')
      end

   end
   methods (Static)

      function obj = loadobj(s)
         if isstruct(s)
            accNum = s.AccountNumber;
            initBal = s.AccountBalance;
            obj = BankAccount(accNum,initBal);
         else
            obj.AccountListener = AccountManager.addAccount(s);
         end
      end

   end
end

classdef BankAccount < handle
   properties (Access = ?AccountManager)
      AccountStatus = 'open'
   end
   properties (SetAccess = private)
      AccountNumber
      AccountBalance
   end
   properties (Transient)
      AccountListener
   end
   events
      InsufficientFunds
   end
   methods
      function BA = BankAccount(accNum,initBal)
         BA.AccountNumber = accNum;
         BA.AccountBalance = initBal;
         BA.AccountListener =  AccountManager.addAccount(BA);
      end
      function deposit(BA,amt)
         BA.AccountBalance = BA.AccountBalance + amt;
         if BA.AccountBalance > 0
            BA.AccountStatus = 'open';
         end
      end
      function withdraw(BA,amt)
         if (strcmp(BA.AccountStatus,'closed')&& BA.AccountBalance <= 0)
            disp(['Account ',num2str(BA.AccountNumber),' has been closed.'])
            return
         end
         newbal = BA.AccountBalance - amt;
         BA.AccountBalance = newbal;
         if newbal < 0
            notify(BA,'InsufficientFunds')
         end
      end
      function getStatement(BA)
         disp('-------------------------')
         disp(['Account: ',num2str(BA.AccountNumber)])
         ab = sprintf('%0.2f',BA.AccountBalance);
         disp(['CurrentBalance: ',ab])
         disp(['Account Status: ',BA.AccountStatus])
         disp('-------------------------')
      end
   end
   methods (Static)
      function obj = loadobj(s)
         if isstruct(s)
            accNum = s.AccountNumber;
            initBal = s.AccountBalance;
            obj = BankAccount(accNum,initBal);
         else
            obj.AccountListener = AccountManager.addAccount(s);
         end
      end
   end
end

Формулировка класса AccountManager

Цель класса AccountManager состоит в том, чтобы предоставить услуги учетным записям. Для класса BankAccount класс AccountManager прислушивается к выводу, который заставляет баланс заскакивать в отрицательную область значений. Когда объект BankAccount инициировал событие InsufficientsFunds, AccountManager сбрасывает состояние счета.

Класс AccountManager не хранит данных, таким образом, ему не нужны свойства. Объектно-ориентированная память BankAccount указатель объекта прослушивателя.

AccountManager выполняет две операции:

Реализация класса AccountManager

Класс AccountManager реализует оба метода как статичные, потому что нет никакой потребности в объекте AccountManager. Эти методы работают с объектами BankAccount.

AccountManager не предназначается, чтобы быть инстанцированным. Разделение функциональности класса AccountManager от класса BankAccount обеспечивает большую гибкость и расширяемость. Например, выполнение так позволяет:

Резюме класса AccountManager

classdef AccountManager

   methods (Static)

   function assignStatus(BA)
      if BA.AccountBalance < 0
         if BA.AccountBalance < -200
            BA.AccountStatus = 'closed';
         else
            BA.AccountStatus = 'overdrawn';
         end
      end
   end

   function lh = addAccount(BA)
      lh = addlistener(BA, 'InsufficientFunds', ...
         @(src, ~)AccountManager.assignStatus(src));
   end

   end
end

 Расширьтесь для кода класса

classdef AccountManager
   methods (Static)
      function assignStatus(BA)
         if BA.AccountBalance < 0
            if BA.AccountBalance < -200
               BA.AccountStatus = 'closed';
            else
               BA.AccountStatus = 'overdrawn';
            end
         end
      end
      function lh = addAccount(BA)
         lh = addlistener(BA, 'InsufficientFunds', ...
            @(src, ~)AccountManager.assignStatus(src));
      end
   end
end

Используя объекты BankAccount

Класс BankAccount, в то время как чрезмерно простой, демонстрирует, как классы MATLAB ведут себя. Например, создайте объект BankAccount с номером счета и начальным депозитом 500$:

BA = BankAccount(1234567,500)

BA = 

  BankAccount with properties:

      AccountNumber: 1234567
     AccountBalance: 500
    AccountListener: [1x1 event.listener]

Используйте метод getStatement, чтобы проверять состояние:

getStatement(BA)

-------------------------
Account: 1234567
CurrentBalance: 500.00
Account Status: open
-------------------------

Сделайте вывод в 600$, который приводит к отрицательному остатку на счете:

withdraw(BA,600)
getStatement(BA)

-------------------------
Account: 1234567
CurrentBalance: -100.00
Account Status: overdrawn
-------------------------

Вывод за 600$ инициировал событие InsufficientsFunds. Текущие критерии, заданные классом AccountManager, приводят к состоянию overdrawn.

Сделайте другой вывод в 200$:

withdraw(BA,200)
getStatement(BA)

-------------------------
Account: 1234567
CurrentBalance: -300.00
Account Status: closed
-------------------------

Теперь AccountStatus был установлен в closed прослушивателем, и дальнейшие попытки сделать вывод блокируются, не инициировав событие:

withdraw(BA,100)

Account 1234567 has been closed.

Если AccountBalance возвращен в положительное значение депозитом, то AccountStatus возвращен, чтобы открыться, и вывод позволен снова:

deposit(BA,700)
getStatement(BA)

-------------------------
Account: 1234567
CurrentBalance: 400.00
Account Status: open
-------------------------