Inheritance diagram for OpenPSTD::CLI::CLIOutput:

Collaboration diagram for OpenPSTD::CLI::CLIOutput:

Public Member Functions
	CLIOutput (std::shared_ptr< Shared::PSTDFile > file)

virtual void	Callback (Kernel::CALLBACKSTATUS status, std::string message, int frame) override
	This callback will be called with information how far the kernel is progressed. More...

virtual void	WriteFrame (int frame, int domain, Kernel::PSTD_FRAME_PTR data) override
	Return pressure data of scene to callback handler. More...

virtual void	WriteSample (int startSample, int receiver, std::vector< float > data) override
	Return receiver data of scene to callback handler. More...

Member Function Documentation

void OpenPSTD::CLI::CLIOutput::Callback	(	Kernel::CALLBACKSTATUS	status,
		std::string	message,
		int	frame
	)

overridevirtual

This callback will be called with information how far the kernel is progressed.

Parameters

status	CALLBACKSTATUS enum, either one of starting/running/finishing/error.
message	Message to pass to callback handler
frame	either positive integer corresponding to time step of data or -1 when kernel is not running.

void OpenPSTD::CLI::CLIOutput::WriteFrame	(	int	frame,
		int	domain,
		Kernel::PSTD_FRAME_PTR	data
	)

overridevirtual

Return pressure data of scene to callback handler.

Parameters

frame	Positive integer corresponding to time step of data.
domain	an identifier that identifies the domain
data	1D row-major vector of pressure data.

void OpenPSTD::CLI::CLIOutput::WriteSample	(	int	startSample,
		int	receiver,
		std::vector< float >	data
	)

overridevirtual

Return receiver data of scene to callback handler.

Parameters

startSample	Positive integer corresponding to time step of the first data point.
receiver	an identifier that identifies the receiver
data	a set of data points

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

Public Member Functions