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

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

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

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

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

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

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

Эти функции определяют требования BankAccount и AccountManager классы. Включать только те функциональные возможности, которые необходимы для достижения ваших конкретных целей. Поддержка специальных типов счетов путем подклассирования 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 сбрасывает состояние учетной записи.

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

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

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

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

The 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

The 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
-------------------------