6. 10 Шаблон "посетитель" (Visitor)

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

Для определения действий, которые необходимо выполнить, требуется знать тип операции и тип объекта. Перед выполнением операции ни один из типов не известен, однако, они определяются при помощи механизма виртуальных функций в элементе структуры и в посетителе. Такой подход получил название двойной диспетчеризации.

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

// Пример 6.9.1 - шаблон "посетитель"

#include <vector>

#include <iostream>

#include <ctime>

class Visitor;

// Базовый класс для элементов

class Transport

{

public:

virtual ~Transport() = 0 {};

virtual void accept(Visitor* v) = 0;

virtual float maxSpeed() = 0;

virtual float mass() = 0;

};

class Horse : public Transport {

public:

void accept(Visitor* v);

int numHoof() { return 4; }

float maxSpeed() { return 50.f; };

float mass() { return 300.f; };

};

class Tractor : public Transport {

public:

void accept(Visitor* v);

float caterpillarSquare() { return 300.f; }

float maxSpeed() { return 30.f; };

float mass() { return 6000.f; };

};

class Car : public Transport {

public:

void accept(Visitor* v);

int numWheels() { return 4; }

float maxSpeed() { return 150.f; };

float mass() { return 1200.f; };

};

В следующем фрагменте кода представлен базовый класс посетителя − Visitor и набор подклассов, отвечающих за различные операции, выполняемые над транспортными средствами. NumHoofsVisitor − суммарное количество копыт, NumWheelsVisitor − суммарное количество колес, CaterpillarSquareVisitor − общая площадь гусениц, AvgMaxSpeedVisitor − средняя максимальная скорость, TotalMassVisitor − общая масса транспортных средств, CountVisitor − общее количество транспортных средств.

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

// Пример 6.9.2 - шаблон "посетитель"

// Интерфейс для посетителей, запросов, операций

class Visitor {

public:

virtual void visit(Horse*) = 0;

virtual void visit(Tractor*) = 0;

virtual void visit(Car*) = 0;

};

// Посетитель для расчета количества копыт

class NumHoofsVisitor : public Visitor {

int numHoofs;

public:

NumHoofsVisitor() : numHoofs(0) {}

int getNumHoofs() { return numHoofs; }

virtual void visit(Horse* t) {

numHoofs += t->numHoof(); }

virtual void visit(Tractor* t) {}

virtual void visit(Car* t) {}

};

// Посетитель для расчета количества колес

class NumWheelsVisitor : public Visitor {

int numWheels;

public:

NumWheelsVisitor() : numWheels(0) {}

int getNumWheels() { return numWheels; }

virtual void visit(Horse* t) {}

virtual void visit(Tractor* t) {}

virtual void visit(Car* t) {

numWheels += t->numWheels(); }

};

// Посетитель для расчета суммарной площади гусениц

class CaterpillarSquareVisitor : public Visitor {

float square;

public:

CaterpillarSquareVisitor() : square(0) {}

float getSquare() { return square; }

virtual void visit(Horse* t) {}

virtual void visit(Tractor* t) {

square += t->caterpillarSquare(); }

virtual void visit(Car* t) {}

};

// Посетитель для расчета средней максимальной скорости

class AvgMaxSpeedVisitor : public Visitor {

float speed;

int count;

public:

AvgMaxSpeedVisitor() : speed(0), count(0) {}

float getSpeed() {

return count == 0 ? 0 : speed / count; }

virtual void visit(Horse* t) {

speed += t->maxSpeed(); ++count; }

virtual void visit(Tractor* t) {

speed += t->maxSpeed(); ++count; }

virtual void visit(Car* t) {

speed += t->maxSpeed(); ++count; }

};

// Посетитель для расчета суммарной массы

class TotalMassVisitor : public Visitor {

float mass;

public:

TotalMassVisitor() : mass(0) {}

float getMass() { return mass; }

virtual void visit(Horse* t) { mass += t->mass(); }

virtual void visit(Tractor* t) { mass += t->mass(); }

virtual void visit(Car* t) { mass += t->mass(); }

};

// Посетитель для расчета количества транспортных средств

class CountVisitor : public Visitor {

int count;

public:

CountVisitor(): count(0) {}

int getCount() { return count; }

virtual void visit(Horse* t) { ++count; }

virtual void visit(Tractor* t) { ++count; }

virtual void visit(Car* t) { ++count; }

};

// Реализация методов для приема посетителей транспортными средствами

void Horse::accept(Visitor *v) { v->visit(this); }

void Tractor::accept(Visitor *v) { v->visit(this); }

void Car::accept(Visitor *v) { v->visit(this); }

Класс TransportDB представляет собой коллекцию транспортных средств − массив указателей и механизм применения посетителей ко всем элементам − метод accept().

// Пример 6.9.3 - шаблон "посетитель"

// База транспортных средств. Хранит транспортные средства и

// предоставляет доступ к ним для посетителей.

class TransportDB

{

std::vector<Transport*> mTransport;

public:

// Заполнение контейнера случайными транспортными средствами

TransportDB() {

srand(time(0));

for(int i = 0; i != 100; ++i) {

int t = rand( ) % 3;

if(0 == t) mTransport.push_back(new Horse());

if(1 == t) mTransport.push_back(new Tractor());

if(2 == t) mTransport.push_back(new Car());

}

}

// Принимает некоторого посетителя v (Visitor*).

// Перенаправляет запрос к каждому элементу.

// ! Тип запроса (Visitor) и

//тип элемента (Transport) не известны.

void accept(Visitor* v) {

for(std::vector<Transport*>::iterator it =

mTransport.begin();

it != mTransport.end();

++it)

{

// Будет вызвана функция accept

//у конкретного подкласса

(*it)->accept(v);

}

}

};

В тестовом примере происходит создание посетителей, применение их ко всем элементам коллекции и вывод результатов.

// Пример 6.9.4 - шаблон посетитель

int main()

{

CountVisitor count;

NumHoofsVisitor numHoofs;

NumWheelsVisitor numWheels;

CaterpillarSquareVisitor catSquare;

AvgMaxSpeedVisitor avgMaxSpeed;

TotalMassVisitor totalMass;

TransportDB db;

db.accept(&count);

db.accept(&numHoofs);

db.accept(&numWheels);

db.accept(&catSquare);

db.accept(&avgMaxSpeed);

db.accept(&totalMass);

std::cout << "CountVisitor: " <<

count.getCount() << std::endl;

std::cout << "NumHoofsVisitor: " <<

numHoofs.getNumHoofs() << std::endl;

std::cout << "NumWheelsVisitor: " <<

numWheels.getNumWheels() << std::endl;

std::cout << "CaterpillarSquareVisitor: " <<

catSquare.getSquare() << std::endl;

std::cout << "AvgMaxSpeedVisitor: " <<

avgMaxSpeed.getSpeed() << std::endl;

std::cout << "TotalMassVisitor: " <<

totalMass.getMass() << std::endl;

system("pause");

}

Результат работы программы следующий:

CountVisitor: 100

NumHoofsVisitor: 176

NumWheelsVisitor: 104

CaterpillarSquareVisitor: 9000

AvgMaxSpeedVisitor: 70

TotalMassVisitor: 224400

Как легко убедиться шаблон посетитель позволяет добавлять операции элементам коллекции в зависимости от типа объекта. Без использования данного шаблона эти операции могли быть добавлены в виде методов класса TransportDB, что привело бы к увеличению его размеров.