mdf::IFileHistory Class Reference

Interface class against an MDF FH block. More...

#include "mdf/ifilehistory.h"

Inheritance diagram for mdf::IFileHistory:

Collaboration diagram for mdf::IFileHistory:

Public Member Functions
virtual void	Time (uint64_t ns_since_1970)=0
	Sets the time when the history block was created.
virtual void	Time (ITimestamp &timestamp)=0
	Sets the time using an ITimestamp object.
virtual uint64_t	Time () const =0
	Returns the time for the history block.
virtual const mdf::IMdfTimestamp *	StartTimestamp () const =0
	Returns the start timestamp of the measurement.
virtual IMetaData *	CreateMetaData ()=0
	Returns an interface against a MD4 block.
virtual const IMetaData *	MetaData () const =0
	Returns an constant interface against a MD4 block.
void	Description (const std::string &description)
	Sets the description for the history block.
std::string	Description () const
	Returns the description.
void	ToolName (const std::string &tool_name)
	Sets the tool name.
std::string	ToolName () const
	Returns the tool name.
void	ToolVendor (const std::string &tool_vendor)
	Sets the tool vendor.
std::string	ToolVendor () const
	Returns the tool vendor.
void	ToolVersion (const std::string &tool_version)
	Sets the tool version.
std::string	ToolVersion () const
	Returns the tool version.
void	UserName (const std::string &user)
	Sets the user name.
std::string	UserName () const
	Returns the user name.
Public Member Functions inherited from mdf::IBlock
virtual	~IBlock ()=default
	Default destructor.
virtual int64_t	Index () const =0
	File position within the file.
virtual std::string	BlockType () const =0
	Returns the block type.

Detailed Description

Interface against an MDF4 file history block. An MDF4 file must have at least one history block that defines it creation. Each time the file is modified, there should be a new history block appended.

Member Function Documentation

CreateMetaData()

virtual IMetaData * mdf::IFileHistory::CreateMetaData ( )

nodiscardpure virtual

Returns

Pointer to an meta data block.

Description() [1/2]

std::string mdf::IFileHistory::Description ( ) const

inlinenodiscard

Returns the description.

Returns

Description of the history block.

Description() [2/2]

void mdf::IFileHistory::Description ( const std::string & description )

inline

Sets the description of the history block. The value is stored int the TX tag in the meta data block.

Parameters

description

Description of history block.

MetaData()

virtual const IMetaData * mdf::IFileHistory::MetaData ( ) const

nodiscardpure virtual

Returns

Pointer to an meta data block.

StartTimestamp()

virtual const mdf::IMdfTimestamp * mdf::IFileHistory::StartTimestamp ( ) const

nodiscardpure virtual

This function returns the start timestamp of the measurement as a pointer to an IMdfTimestamp object.

Returns

Pointer to an IMdfTimestamp object representing the start timestamp.

Time() [1/3]

virtual uint64_t mdf::IFileHistory::Time ( ) const

nodiscardpure virtual

Sets the time the history block was created.

Returns

Nanoseconds since 1970.

Time() [2/3]

virtual void mdf::IFileHistory::Time ( ITimestamp & timestamp )

pure virtual

This function sets the time for the history block using an ITimestamp object.

Parameters

timestamp

An ITimestamp object representing the time.

Time() [3/3]

virtual void mdf::IFileHistory::Time ( uint64_t ns_since_1970 )

pure virtual

Sets the absolute start time for the measurement file. It is default set by the application to now.

Parameters

ns_since_1970

Nanoseconds since 1970.

ToolName() [1/2]

std::string mdf::IFileHistory::ToolName ( ) const

inlinenodiscard

Returns

Tool name.

ToolName() [2/2]

void mdf::IFileHistory::ToolName ( const std::string & tool_name )

inline

Mandatory text that identify the tool name.

Parameters

tool_name

Name of the tool.

ToolVendor() [1/2]

std::string mdf::IFileHistory::ToolVendor ( ) const

inlinenodiscard

Returns

Tool vendor.

ToolVendor() [2/2]

void mdf::IFileHistory::ToolVendor ( const std::string & tool_vendor )

inline

Mandatory text that identify the tool vendor.

Parameters

tool_vendor

Vendor name.

ToolVersion() [1/2]

std::string mdf::IFileHistory::ToolVersion ( ) const

inlinenodiscard

Returns

Tool version.

ToolVersion() [2/2]

void mdf::IFileHistory::ToolVersion ( const std::string & tool_version )

inline

Mandatory text that identify the tool version.

Parameters

tool_version

Version string.

UserName() [1/2]

std::string mdf::IFileHistory::UserName ( ) const

inlinenodiscard

Returns

User name.

UserName() [2/2]

void mdf::IFileHistory::UserName ( const std::string & user )

inline

Optional text that identify the user.

Parameters

user	User name.

---

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

• include/mdf/ifilehistory.h