Aleph::CA::HTML_Player_Frame_Sink< Mapper > Class Template Reference

Sink that writes a self-contained HTML playback file. More...

#include <ca-html-player.H>

Collaboration diagram for Aleph::CA::HTML_Player_Frame_Sink< Mapper >:

Public Member Functions
	HTML_Player_Frame_Sink (std::filesystem::path path, Mapper mapper, HTML_Player_Options opts={})
	Build an HTML player sink.
template<typename Lattice >
void	accept (const std::size_t step, const Lattice &frame)
	Append one frame to the embedded trajectory.
void	flush () const
	Write the final self-contained HTML file.
std::size_t	size () const noexcept
	Return collected frame count.

Private Attributes
std::filesystem::path	path_
Mapper	mapper_
HTML_Player_Options	opts_ {}
Array< ca_html_detail::Frame >	frames_

Detailed Description

template<typename Mapper>
class Aleph::CA::HTML_Player_Frame_Sink< Mapper >

Sink that writes a self-contained HTML playback file.

Template Parameters

Mapper

invocable state_type -> RGB8.

Definition at line 133 of file ca-html-player.H.

Constructor & Destructor Documentation

HTML_Player_Frame_Sink()

template<typename Mapper >

Aleph::CA::HTML_Player_Frame_Sink< Mapper >::HTML_Player_Frame_Sink ( std::filesystem::path  path, Mapper  mapper, HTML_Player_Options  opts = {}  )

inline

Build an HTML player sink.

Parameters

[in]	path	output .html file.
[in]	mapper	state-to-RGB mapper.
[in]	opts	player options.

Definition at line 146 of file ca-html-player.H.

Member Function Documentation

accept()

template<typename Mapper >

template<typename Lattice >

void Aleph::CA::HTML_Player_Frame_Sink< Mapper >::accept ( const std::size_t  step, const Lattice &  frame  )

inline

Append one frame to the embedded trajectory.

Template Parameters

Lattice

rank-2 lattice type.

Parameters

[in]	step	simulation step.
[in]	frame	frame to collect.

Definition at line 158 of file ca-html-player.H.

References Aleph::CA::Lattice< Storage, Boundary >::at(), Aleph::blossom_maximum_cardinality_matching(), Aleph::CA::HTML_Player_Frame_Sink< Mapper >::frames_, Aleph::CA::ca_html_detail::Frame::height, Aleph::CA::HTML_Player_Frame_Sink< Mapper >::mapper_, Aleph::CA::ca_html_detail::Frame::pixels, r, Aleph::CA::Lattice< Storage, Boundary >::rank, Aleph::CA::Lattice< Storage, Boundary >::size(), Aleph::CA::ca_html_detail::Frame::step, and Aleph::CA::ca_html_detail::Frame::width.

Referenced by TEST().

flush()

template<typename Mapper >

void Aleph::CA::HTML_Player_Frame_Sink< Mapper >::flush ( ) const

inline

Write the final self-contained HTML file.

Exceptions

std::runtime_error

on file or stream failure.

Definition at line 179 of file ca-html-player.H.

References ah_runtime_error_if, Aleph::blossom_maximum_cardinality_matching(), Aleph::CA::HTML_Player_Options::cell_size, Aleph::CA::HTML_Player_Options::fps, Aleph::CA::HTML_Player_Frame_Sink< Mapper >::frames_, Aleph::CA::ca_html_detail::html_escape(), Aleph::CA::HTML_Player_Frame_Sink< Mapper >::opts_, out, Aleph::CA::HTML_Player_Frame_Sink< Mapper >::path_, Aleph::CA::HTML_Player_Options::show_grid, Aleph::CA::HTML_Player_Options::title, and Aleph::CA::ca_html_detail::write_frame_json().

size()

template<typename Mapper >

std::size_t Aleph::CA::HTML_Player_Frame_Sink< Mapper >::size ( ) const

inlinenoexcept

Return collected frame count.

Returns

number of frames currently buffered.

Definition at line 217 of file ca-html-player.H.

Member Data Documentation

frames_

template<typename Mapper >

Array<ca_html_detail::Frame> Aleph::CA::HTML_Player_Frame_Sink< Mapper >::frames_

private

Definition at line 138 of file ca-html-player.H.

Referenced by Aleph::CA::HTML_Player_Frame_Sink< Mapper >::accept(), and Aleph::CA::HTML_Player_Frame_Sink< Mapper >::flush().

mapper_

template<typename Mapper >

Mapper Aleph::CA::HTML_Player_Frame_Sink< Mapper >::mapper_

private

Definition at line 136 of file ca-html-player.H.

Referenced by Aleph::CA::HTML_Player_Frame_Sink< Mapper >::accept().

opts_

template<typename Mapper >

HTML_Player_Options Aleph::CA::HTML_Player_Frame_Sink< Mapper >::opts_ {}

private

Definition at line 137 of file ca-html-player.H.

Referenced by Aleph::CA::HTML_Player_Frame_Sink< Mapper >::flush().

path_

template<typename Mapper >

std::filesystem::path Aleph::CA::HTML_Player_Frame_Sink< Mapper >::path_

private

Definition at line 135 of file ca-html-player.H.

Referenced by Aleph::CA::HTML_Player_Frame_Sink< Mapper >::flush().

---

The documentation for this class was generated from the following file:

• ca-html-player.H