Concrete strategy for a BMP image recording. More...

#include <VisionX/libraries/imrec/record/strats/BMPRecordingStrategy.h>

Inheritance diagram for BMPRecordingStrategy:

Public Member Functions
	BMPRecordingStrategy ()

	BMPRecordingStrategy (const std::filesystem::path &filePath, const std::string &name)

void	recordFrame (const CByteImage &frame, std::chrono::microseconds timestamp) override
	Adds the given frame to the recording. More...

	~BMPRecordingStrategy () override

Public Member Functions inherited from AbstractSequencedRecordingStrategy
	AbstractSequencedRecordingStrategy ()
	Default constructor to manually start the recording. More...

	AbstractSequencedRecordingStrategy (const std::filesystem::path &filePath, const std::filesystem::path &ext)

std::filesystem::path	getDotExtension () const override
	Gets the extension plus preceeded dot of the configured file (e.g. More...

std::filesystem::path	getMetadataPath () const override

void	startRecording () override
	Starts the recording manually if constructed empty. More...

	~AbstractSequencedRecordingStrategy () override
	Destruct the recording strategy. More...

Public Member Functions inherited from AbstractRecordingStrategy
	AbstractRecordingStrategy ()
	Default constructor to start the recording manually. More...

	AbstractRecordingStrategy (const std::filesystem::path &filePath)
	Constructor for any recording strategy, immediately starting the recording. More...

virtual std::filesystem::path	getFilePath () const
	Gets the raw file path for the recording as configured. More...

virtual std::filesystem::path	getPath () const
	Gets the path to the recording without filename. More...

virtual std::filesystem::path	getStem () const
	Gets the stem of the configured file (filename without extension) More...

virtual bool	isRecording () const
	Indicates whether this instance is already initialised for recording. More...

virtual void	recordFrame (const cv::Mat &frame, std::chrono::microseconds timestamp)
	Adds the given frame to the recording. More...

virtual void	stopRecording ()
	Stops the recording. More...

virtual void	writeMetadataDatetime (const std::string &var_name, std::chrono::microseconds timestamp)

virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const CByteImage &frame, std::chrono::microseconds timestamp)

virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const cv::Mat &frame, std::chrono::microseconds timestamp)

virtual void	writeMetadataLine (const std::string &var_name, std::string_view var_type, std::string_view var_value)

virtual	~AbstractRecordingStrategy ()
	Destructor. More...

Additional Inherited Members
Protected Member Functions inherited from AbstractSequencedRecordingStrategy
std::filesystem::path	deriveFramePath (const unsigned int sequence_number, const std::string &frame_name)
	Returns the next sequenced full path and increments the sequence number. More...

Protected Attributes inherited from AbstractRecordingStrategy
std::filesystem::path	m_file_path
	Path to where the recording file should be written to. More...

Detailed Description

Concrete strategy for a BMP image recording.

Definition at line 41 of file BMPRecordingStrategy.h.

Constructor & Destructor Documentation

◆ BMPRecordingStrategy() [1/2]

BMPRecordingStrategy ( )

Definition at line 31 of file BMPRecordingStrategy.cpp.

◆ BMPRecordingStrategy() [2/2]

BMPRecordingStrategy	(	const std::filesystem::path &	filePath,
		const std::string &	name
	)

Definition at line 37 of file BMPRecordingStrategy.cpp.

◆ ~BMPRecordingStrategy()

~BMPRecordingStrategy ( )

override

Definition at line 44 of file BMPRecordingStrategy.cpp.

Member Function Documentation

◆ recordFrame()

void recordFrame	(	const CByteImage &	frame,
		std::chrono::microseconds	timestamp
	)

overridevirtual

Adds the given frame to the recording.

Parameters

frame Frame to be added

Reimplemented from AbstractRecordingStrategy.

Definition at line 51 of file BMPRecordingStrategy.cpp.

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

VisionX/libraries/imrec/record/strats/BMPRecordingStrategy.h
VisionX/libraries/imrec/record/strats/BMPRecordingStrategy.cpp

Public Member Functions