mdf::IEvent Class Reference

Interface against an event block. More...

#include <ievent.h>

Inheritance diagram for mdf::IEvent:

Collaboration diagram for mdf::IEvent:

Public Member Functions
virtual void	Name (const std::string &name)=0
	Sets the name.
virtual const std::string &	Name () const =0
	Name.
virtual void	GroupName (const std::string &group_name)=0
	Sets the group name.
virtual const std::string &	GroupName () const =0
	Returns the group name.
virtual void	Type (EventType event_type)=0
	Sets type of event.
virtual EventType	Type () const =0
	Type of event.
std::string	TypeToString () const
	Typ as string.
virtual void	Sync (SyncType sync_type)=0
	Sets type of sync.
virtual SyncType	Sync () const =0
	Type of sync.
virtual void	Range (RangeType range_type)=0
	Sets type of range.
virtual RangeType	Range () const =0
	Type of range.
std::string	RangeToString () const
	Range to string.
virtual void	Cause (EventCause cause)=0
	Sets the cause.
virtual EventCause	Cause () const =0
	Cause of event.
std::string	CauseToString () const
	Cause to string.
virtual void	CreatorIndex (size_t index)=0
	Sets the creator index.
virtual size_t	CreatorIndex () const =0
	Creator index.
virtual void	SyncValue (int64_t value)=0
	Sets the sync value.
virtual int64_t	SyncValue () const =0
	Sync value.
virtual void	SyncFactor (double factor)=0
	Sets the factor.
virtual double	SyncFactor () const =0
	Sync factor.
std::string	ValueToString () const
	Sync value as string.
virtual void	ParentEvent (const IEvent *parent)=0
	Sets the parent event.
virtual const IEvent *	ParentEvent () const =0
	Returns the parent event.
virtual void	RangeEvent (const IEvent *range_event)=0
	Sets the range.
virtual const IEvent *	RangeEvent () const =0
	Returns the range.
virtual void	AddScope (const void *scope)=0
	Adds a scope reference.
virtual const std::vector< const void * > &	Scopes () const =0
	Returns referenced CN and CG blocks.
virtual void	AddAttachment (const IAttachment *attachment)=0
	Adds an attachment reference.
virtual const std::vector< const IAttachment * > &	Attachments () const =0
	Returns a list of attachment references.
virtual IMetaData *	CreateMetaData ()=0
	Returns an interface against an MD4 block.
virtual const IMetaData *	MetaData () const =0
	Returns an constant interface against a MD4 block.
void	Description (const std::string &description)
	Sets description.
std::string	Description () const
	Returns description.
void	PreTrig (double pre_trig)
	Sets the pre-trig time (s).
double	PreTrig () const
	Returns the pre-trig value (s).
void	PostTrig (double post_trig)
	Sets the post-trig value (s)
double	PostTrig () const
	Returns the post-trig value (s).
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

The event (EV) block is used to store events text and data. It is rather flexible block type which makes it difficult to simplify.

Member Function Documentation

CreateMetaData()

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

nodiscardpure virtual

Returns

Pointer to a meta data block.

MetaData()

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

nodiscardpure virtual

Returns

Pointer to a meta data block.

---

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

• include/mdf/ievent.h