Коллекции сумм

НовыйОписаниеКоллекцииСумм

Описание, пример вызова

// Конструктор описания коллекции
//
// Пример:
//  Описание = НовыйОписаниеКоллекцииСумм();
//  ДобавитьНаборСумм(Описание, "БухгалтерскийНалоговыйУчет", "Сумма,СуммаНУ");
//  ДобавитьНаборСумм(Описание, "ЭлементыЗатрат");
//
Функция НовыйОписаниеКоллекцииСумм() Экспорт

Пример вызова

Результат = КоллекцииСумм.НовыйОписаниеКоллекцииСумм()

ДобавитьНаборСумм

Описание, пример вызова

// Добавляет в описание коллекции сумм описание набора.
//
// Параметры:
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
//  ИмяНабора         - Строка
//
//  СоставНабора      - Строка - для набора с фиксированным составом: имена свойств коллекции, разделенные запятыми
//                    - Неопределено - указывает, что состав набора переменный.
//
Процедура ДобавитьНаборСумм(ОписаниеКоллекции, ИмяНабора, СоставНабора = Неопределено) Экспорт

Пример вызова

КоллекцииСумм.ДобавитьНаборСумм(ОписаниеКоллекции, ИмяНабора, СоставНабора);

ЕстьНаборСумм

Описание, пример вызова

// Проверяет наличие набора в описании коллекции сумм.
//
// Параметры:
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
//  ИмяНабора         - Строка
//
// Возвращаемое значение:
//  Булево
//
Функция ЕстьНаборСумм(ОписаниеКоллекции, ИмяНабора) Экспорт

Пример вызова

Результат = КоллекцииСумм.ЕстьНаборСумм(ОписаниеКоллекции, ИмяНабора)

ИменаСвойствСтрокой

Описание, пример вызова

// Определяет перечень свойств фиксированных наборов коллекции сумм.
//
// Параметры:
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
// Возвращаемое значение:
//  Строка - перечень имен свойств, разделенных запятыми.
//
Функция ИменаСвойствСтрокой(ОписаниеКоллекции) Экспорт

Пример вызова

Результат = КоллекцииСумм.ИменаСвойствСтрокой(ОписаниеКоллекции)

ИменаСвойств

Описание, пример вызова

// Определяет перечень свойств фиксированных наборов коллекции сумм.
//
// Параметры:
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
// Возвращаемое значение:
//  Массив - элементы массива - строки, имена свойств.
//
Функция ИменаСвойств(ОписаниеСумм) Экспорт

Пример вызова

Результат = КоллекцииСумм.ИменаСвойств(ОписаниеСумм)

НовыйКоллекцияСумм

Описание, пример вызова

// Конструктор коллекции сумм.
//
// Параметры:
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм()
//  ДляЗаполнения - Булево - Истина, если коллекция следом будет неминуемо заполнена.
//                  Передача параметра пропускает заполнение значениями по умолчанию
//                  и тем самым позволяет оптимизировать время выполнения.
//
Функция НовыйКоллекцияСумм(ОписаниеКоллекции, ДляЗаполнения = Ложь) Экспорт

Пример вызова

Результат = КоллекцииСумм.НовыйКоллекцияСумм(ОписаниеКоллекции, ДляЗаполнения);

Заполнить

Описание, пример вызова

// Заполняет коллекцию сумм на основании другой коллекции сумм.
//
// Параметры:
//  Коллекция         - Заполняемая коллекция - должна соответствовать ОписаниеКоллекций.
//
//  Основание         - Коллекция сумм - должна соответствовать ОписаниеКоллекций
//
//  ОписаниеКоллекций - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
//  СоответствиеИмен  - Соответствие - (необязательный) правила соответствия имен свойств коллекции-основания и
//                      заполняемой коллекции. В ключе элемента соответствия - имя свойства заполняемой коллекции,
//                      в значении - имя свойства коллекции-основания.
//
Процедура Заполнить(Коллекция, Основание, ОписаниеКоллекций, СоответствиеИмен = Неопределено) Экспорт

Пример вызова

КоллекцииСумм.Заполнить(Коллекция, Основание, ОписаниеКоллекций, СоответствиеИмен);

ДополнитьТаблицуЗначенийКолонкамиСумм

Описание, пример вызова

// Позволяет работать со строками таблицы значений как с коллекциями сумм.
// Перед первым изменением переменного набора сумм в каждой из строк,
// следует инициализировать этот набор - см. ИнициализироватьПеременныйНаборСумм.
//
// Параметры:
//  Результат         - ТаблицаЗначений - дополняемая таблица значений (коллекция коллекций сумм).
//
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//                      Таблица значений приводится к этому описанию.
//
Процедура ДополнитьТаблицуЗначенийКолонкамиСумм(Результат, ОписаниеКоллекции) Экспорт

Пример вызова

КоллекцииСумм.ДополнитьТаблицуЗначенийКолонкамиСумм(Результат, ОписаниеКоллекции)

НовыйПеременныйНаборСумм

Описание, пример вызова

Функция НовыйПеременныйНаборСумм() Экспорт

Пример вызова

Результат = КоллекцииСумм.НовыйПеременныйНаборСумм());

ИнициализироватьПеременныйНаборСумм

Описание, пример вызова

// Позволяет изменять переменный набор сумм, входящий в коллекцию,
// созданную без использования конструктора НовыйКоллекцияСумм().
//
// Параметры:
//  Коллекция - Заполняемая коллекция - должна включать переменный набор сумм с именем ИмяНабора.
//
//  ИмяНабора - Строка - имя инициализируемого набора
//
// Возвращаемое значение:
//  ТаблицаЗначений - переменный набор сумм.
//
Функция ИнициализироватьПеременныйНаборСумм(Коллекция, ИмяНабора) Экспорт

Пример вызова

Результат = КоллекцииСумм.ИнициализироватьПеременныйНаборСумм(Коллекция, ИмяНабора)

ТипСумма

Описание, пример вызова

Функция ТипСумма() Экспорт

Пример вызова

Результат = КоллекцииСумм.ТипСумма());

ТипИдентификатораВершины

Описание, пример вызова

Функция ТипИдентификатораВершины() Экспорт

Пример вызова

Результат = КоллекцииСумм.ТипИдентификатораВершины());

Сложить

Описание, пример вызова

// Прибавляет к каждой из сумм, входящей в коллекцию А, соответствующую сумму, входящую в коллекцию Б.
//
// Параметры:
//  КоллекцияА        - первое слагаемое, модифицируемая коллекция, должна соответствовать ОписаниеКоллекций.
//
//  КоллекцияБ        - второе слагаемое, не изменяется, должна соответствовать ОписаниеКоллекций.
//
//  ОписаниеКоллекций - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
Процедура Сложить(КоллекцияА, КоллекцияБ, ОписаниеКоллекций) Экспорт

Пример вызова

КоллекцииСумм.Сложить(КоллекцияА, КоллекцияБ, ОписаниеКоллекций)

Вычесть

Описание, пример вызова

// Вычитает из каждой из сумм, входящей в коллекцию А, соответствующую сумму, входящую в коллекцию Б.
//
// Параметры:
//  КоллекцияА        - уменьшаемое, модифицируемая коллекция, должна соответствовать ОписаниеКоллекций.
//
//  КоллекцияБ        - вычитаемое, не изменяется, должна соответствовать ОписаниеКоллекций.
//
//  ОписаниеКоллекций - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
Процедура Вычесть(КоллекцияА, КоллекцияБ, ОписаниеКоллекций) Экспорт

Пример вызова

КоллекцииСумм.Вычесть(КоллекцияА, КоллекцияБ, ОписаниеКоллекций)

Пустая

Описание, пример вызова

// Проверяет коллекцию сумм на тривиальность.
//
// Параметры:
//  Коллекция - проверяемая коллекция сумм, должна соответствовать ОписаниеКоллекции.
//
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
// Возвращаемое значение:
//  Булево - Истина, если все суммы в коллекции не заполнены (равны нулю).
//
Функция Пустая(Коллекция, ОписаниеКоллекции) Экспорт

Пример вызова

Результат = КоллекцииСумм.Пустая(Коллекция, ОписаниеКоллекции)

Ограничить

Описание, пример вызова

// Обеспечивает, что все суммы фиксированных наборов коллекции Суммы
// будут меньше или равны соответствующим суммам в коллекции Ограничения.
//
// Параметры:
//  Суммы        - контролируемая (модифицируемая) коллекция, должна соответствовать ОписаниеКоллекций.
//
//  Ограничения  - не изменяется, должна соответствовать ОписаниеКоллекций
//
//  ОписаниеКоллекций - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
Процедура Ограничить(Суммы, Ограничения, ОписаниеКоллекций) Экспорт

Пример вызова

КоллекцииСумм.Ограничить(Суммы, Ограничения, ОписаниеКоллекций)

Доля

Описание, пример вызова

// Рассчитывает долю для каждого элемента коллекции сумм.
// Результат помещает в новую коллекцию.
//
// Параметры:
//  Коллекция         - коллекция сумм, доли которых надо рассчитать; должна соответствовать ОписаниеКоллекций.
//
//  ОписаниеКоллекции - описание, сконструированное функцией НовыйОписаниеКоллекцииСумм().
//
//  Числитель         - Число
//
//  Знаменатель       - Число
//
// Возвращаемое значение:
//  Коллекция, сконструированная функцией НовыйКоллекцияСумм(), содержит доли от переданных сумм.
//
Функция Доля(Коллекция, ОписаниеКоллекции, Числитель, Знаменатель) Экспорт

Пример вызова

Результат = КоллекцииСумм.Доля(Коллекция, ОписаниеКоллекции, Числитель, Знаменатель)

ДоляСуммы

Описание, пример вызова

Функция ДоляСуммы(Знач Сумма, Знач Числитель, Знач Знаменатель) Экспорт

Пример вызова

Результат = КоллекцииСумм.ДоляСуммы(Сумма, Числитель, Знаменатель)

ЭлементПеременногоНабораСумм

Описание, пример вызова

Функция ЭлементПеременногоНабораСумм(Коллекция, ИмяНабора, Индекс) Экспорт

Пример вызова

Результат = КоллекцииСумм.ЭлементПеременногоНабораСумм(Коллекция, ИмяНабора, Индекс)

ДобавитьВПеременныйНаборСумм

Описание, пример вызова

Функция ДобавитьВПеременныйНаборСумм(НаборСумм, Индекс, Сумма) Экспорт

Пример вызова

Результат = КоллекцииСумм.ДобавитьВПеременныйНаборСумм(НаборСумм, Индекс, Сумма)

ИтогПеременногоНабораСумм

Описание, пример вызова

Функция ИтогПеременногоНабораСумм(Коллекция, ИмяНабора) Экспорт

Пример вызова

Результат = КоллекцииСумм.ИтогПеременногоНабораСумм(Коллекция, ИмяНабора)