Индексаторы. 
Программирование. 
Базовый курс с#

Если в класс в качестве поля входит коллекция, например, массив элементов, то в ряде случаев удобно обращаться к элементам коллекции, используя индекс (или индексы, если массив многомерный). Для одномерной коллекции, принадлежащей объекту класса, обращение к ее элементу с помощью индекса будет таким:

ссылка_на_объект [индексное_выражение].

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

Именно наличие в библиотечном классе string индексатора позволяет обращаться к отдельным символам строки, используя операцию индексации:

char буква = «Сообщение» [4];

В результате выполнения этого оператора символьная переменная «буква» будет иметь значение 'щ'.

Индексатор можно считать разновидностью свойства. Как и для свойства, возможности индексатора определяются аксессорами get и set. В отличие от свойства, у индексатора нет собственного уникального имени. При объявлении индексатор всегда именуется служебным словом this, т. е. ссылкой на тот конкретный объект, для которого используется индексатор. Тип возвращаемого значения для индексатора соответствует типу элементов коллекции, с которой ассоциирован индексатор.

Объявление индексатора имеет следующий формат:

модификаторы_индексатора_ор±

тип this [спецификация параметров]

{

декларация get-aKceccopa_opt декларация set-aKceccopa_opt

У

Модификаторы_индексатора те же, что и для свойств за одним исключением — для индексаторов нельзя использовать модификатор static. Индексаторы не могут быть статическими и применимы только к объектам класса (не к классу в целом). Вслед за ключевым словом this в квадратных скобках — спецификация параметров индексатора. Разрешена перегрузка индексаторов, т. е. в одном классе может быть несколько индексаторов, но они должны отличаться друг от друга спецификациями параметров. В этом индексаторы подобны методам. За квадратными скобками размещается код, который можно назвать телом индексатора. Это конструкция, подобная телу свойства, — заключенные в фигурные скобки объявления аксессоров get и set.

Операторы get-аксессора предназначены для получения значения элемента, соответствующего значению индекса. Операторы setаксессора выполняют присваивание значения элементу, соответствующему значению индекса. Вызов индексатора, т. е. выражение.

ссылка_на_объект [список аргументов]

может размещаться слева и справа от операции присваивания. В первом случае выполняется аксессор set, во втором — аксессор get. В теле аксессора set значение, которое нужно использовать для изменения элемента коллекции, всегда представлено контекстным служебным словом value.

В качестве примера класса с индексатором определим класс Work_hours для представления отработанных часов по дням недели. В массиве должно быть 7 элементов, с индексами от 0 (для понедельника) до 6 (для воскресенья). Значения элементов массива — количества отработанных часов по дням недели от 0 (не рабочий день) до 14 часов (больше работать запрещено). Для обращения к элементам массива в класс введен индексатор.

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

// 12₀₃.cs — индексатор — рабочие часы дней недели using System; class Work_hours {.

int[] days; // часы no дням недели public Work_hours () // конструктор { days = new int[7]; } public int this[int d].

{ // индексатор

get { return (d6)? —1: days[d]; }.

set.

{.

if (d 6 || value 14).

Console.WriteLine («Ошибка: день={0}, часы={1}!», d, value);

} } }

class Program.

{

static void Main ().

{

Work_hours week = new Work_hours (); week[0] = 7; // понедельник week[2] = 17; // недопустимые данные week[3] = 7; 11 четверг week[6] = 7; 11 воскресенье Console. WriteLine («Рабочие дни: «); for (int i = 0; i 0).

Console.Write («day[{0}] = {1} «, i, week[i]);

Console.WriteLine ();

Console.WriteLine («day[{0}] = {l} «, 8, week[8]);

} }

Результат выполнения программы:

Ошибка: день=2, часы=17!

Рабочие дни:

day[0] = 7 day[3] = 7 day[6] = 7 day[8] = -1.

Параметр индексатора и соответствующее ему индексное выражение индексатора не обязательно должны иметь целочисленный тип. В следующем примере рассмотрим класс Dictionary, объект которого может служить простейшим словарем. В класс Dictionary включим в качестве полей два массива строк — массив исходных слов, например, на английском языке, и массив переводных эквивалентов. Массив исходных слов будем заполнять в конструкторе при создании словаряобъекта. Элементам массива переводных эквивалентов будем присваивать значения с использованием индексатора. Параметр индексатора будет иметь тип string. Задавая в квадратных скобках английское слово в виде строки, получим доступ к элементу с его переводным эквивалентом. Определение класса может быть таким (программа 12₀₄.cs):

class Dictionary { // словарь

string[] words; // слова

string[] trans; 11 переводы

public Dictionary (params string[] str).

{// конструктор

words = new string[str.Length]; trans = new string[str.Length]; int ind = 0;

foreach (string s in str).

words[ind++] = s; // заполнили массив слов

}

int search (string str).

{ // поиск слова

for (int i = 0; i < words. Length; i++) if (words[i] == str) return i; return -1;

}

public string this[string w].

{

set.

{

int ind = search (w); if (ind == -1).

Console.WriteLine («Слова Нет!»); else trans[ind] = value;

}

get.

{

int ind = search (w);

if (ind == -1) return «Слова Нет!» ;

else return trans[ind];

} } }

В классе Dictionary две ссылки words и trans на массив слов и на массив их переводных эквивалентов. Собственно, массивы как объекты создаются в конструкторе. У конструктора есть параметр с модификатором params, позволяющий использовать переменное число аргументов. Реальное количество аргументов определяется как str.Length. Это значение определяет размеры массивов, адресуемых ссылками words и trans. Строки-аргументы конструктора присваиваются элементам массива words [] в цикле foreach. Массив переводов trans [] остается незаполненным.

В классе определен вспомогательный закрытый метод search (), для поиска в словаре (в массиве words []) слова, заданного с помощью аргумента. Метод вернет индекс слова, либо -1, если слово отсутствует. Метод search () используется в индексаторе. В аксессоре set определяется индекс ind того элемента массива trans [], которому нужно присвоить новое значение переводного эквивалента. Если поиск неудачен — выводится сообщение, иначе элементу trans [ind], присваивается значение переводного эквивалента. Аксессор get возвращает значение trans [ind] либо строку с сообщением, что слова нет в словаре.

Для иллюстрации возможностей класса dictionary и его индексатора приведем следующий фрагмент кода:

static void Main ().

{

Dictionary number = new Dictionary («zero», «one», «two»);

number[" zero" ] = «нуль» ;

number[" one" ] = «один» ;

number[" two" ] = «2» ;

Console.WriteLine («number[» one" ]: «+ number[» one" ]);

Console.WriteLine (^Mnumber[" three" ]: «.

+ number[" three" ]);

Console.WriteLine («number[» two" ]: «+ number[» two" ]);

}

В методе Main () создан один объект класса Dictionary. В объектесловаре всего три слова, у которых вначале нет переводных эквивалентов. Для задания переводов используются выражения с индексами. При обращении к отсутствующему слову значением выражения number [" three" ] будет строка «Слова Нет!» .

Результат выполнения программы:

number[" one" ]: один.

number[" three" ]: Слова Нет!

number[" two" ]: 2.

Для индексаторов, допускающих только чтение (не включающих аксессора set), объявление можно сократить, используя сжатие до выражения:

модификаторы_t тип_результата

this [тип_индекса индекс] => выражение_с_индексом;

Пример индексатора, декларированного с использованием сжатия до выражения, приведем в программе следующего параграфа.

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

В качестве примера рассмотрим класс, представляющий две температурные шкалы. Температура Т° по абсолютной шкале, введенной Вильямом Томсоном (лордом Кельвином), связана с температурой t° по шкале Цельсия соотношением: Г° = t° + 273.16°.

Определим класс Temperature с индексатором, позволяющий получать значение Т° по величине t°, которую будет задавать параметр индексатора. Так как температура по Кельвину не может быть отрицательной, то примем, что при t° < —273.16° индексатор будет возвращать значение -1. Декларация класса:

class Temperature.

{ // Температура по Кельвину и Цельсию public double this[double t] =>

(t < -273.16)? -1: t + 273.16;

}

В классе нет массива, и нет полей, которым нужно присваивать значения с помощью обращений к индексатору, поэтому нет смысла в индексаторе определять аксессор set. Это обстоятельство и возможность выразить действия индексатора с помощью единственного оператора return позволяют использовать синтаксис сжатия до выражения. В отличие от предыдущих примеров параметр индексатора и возвращаемое им значение имеют тип double. Конструктор задается неявно. Применение индексатора иллюстрирует следующий фрагмент кода:

static void Main ().

{

Temperature TK = new Temperature (); double t = 43;

Console.WriteLine («TK[{0}] = {l:f2}», t, TK[t]); t = -400;

Console.WriteLine («TK[{0}] = {l:f2}», t, TK[t]); t = -273;

Console.WriteLine («TK[{0}] = {l:f2}», t, TK[t]);

}

Результат выполнения:

ТК[43] = 316,16 TK[-400] = -1,00 ТК[-273] = 0,16.