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

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

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

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

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

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

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

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

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

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

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

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

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