IPlainObject::Marshal
package<default_package_allocator, IPlainObject> Marshal() const;
package_reference<IPlainObject> Marshal(void* pBuffer, size_type cbBuffer) const;
Шаблон:IPlainObject Marshal brief
- Выделяет память под хранение запакованных данных, которые управляются запаковщиком package.
- Записывает запакованные данные в предоставленный извне буфер.
- Параметры
[in] pBuffer Указатель на буфер памяти, байтовым размером, как минимум, равным значению, возвращаемому методом IPlainObject::MarshalSize. Функция заполняет буфер запакованной секущей плоскостью вывода результатов моделирования. cbBuffer Байтовый размер предоставленного для второй перегрузки буфера данных. - Возможные исключения
Chusov::Exceptions::OutOfMemoryException Исключение, которое может быть сгенерировано перегрузкой 1 в случае нехватки памяти. Chusov::Exceptions::InsufficientBufferException Исключение, которое может быть сгенерировано перегрузкой 2 в случае, если предоставлен слишком малый буфер pBuffer. - См. также
package_reference package make_package Функция, позволяющая создание запакованных объектов на основе их типов, полученных дедукцией и с использованием стандартного менеджера памяти std::allocator.
{{function return_value Объект, управляющий запакованным пакетом данных. Первая перегрузка, в отличие от второй, возвращает объект, также управляющий буфером, хранящим запакованные данные, и автоматически освобождает память при деструкции возвращенного объекта. Вторая перегрузка управляет только данными, но ответственность за освобождения памяти буфера ложится на вызывающего.}} Перегрузка 1 за раз создает смарт объект C++ (см. package), который управляет как запаковкой, так и выделенной им же памятью. Перегрузка 2 позволяет использовать уже существующую память, которая заполняется запакованной плоскостью вывода результатов моделирования.
В обоих случаях полученный пакет данных описывает геометрические параметры плоскости, однако сами результаты в запакованные данные не включаются.
Вторая перегрузка предполагает, что размер предоставленного буфера задан в байтах параметром cbBuffer. Этот размер должен быть не меньше значения, возвращаемого методом IGeometryModel::MarshalSize.
Методы фактически делегируют вызов запаковщику package, на вход которого можно предоставлять экземпляр плоскости напрямую, без вызова методов.
using namespace CAMaaS;
const IPlainObject& plain = get(); //какой-то метод возвращающий read-only ссылку на модель
auto pckg = package<std::allocator, IPlainObject> (plain); //аналогично вызову geom.Marshal();
auto buffer_size = package_reference<IPlainObject>::calculate_size(plain); //аналогично geom.MarshalSize();
auto buffer = new std::uint8_t [buffer_size];
auto pckg_ref = package_reference<IPlainObject> (buffer, buffer_size, plain); //аналогично вызову geom.Marshal(buffer, buffer_size);
}}