HPS::AnnotationOperator::AnnotationInsertedEvent Class Reference

#include <sprk_ops.h>

Inheritance diagram for HPS::AnnotationOperator::AnnotationInsertedEvent:
HPS::Event

Public Member Functions

 AnnotationInsertedEvent ()
 
AnnotationInsertedEvent (HPS::SegmentKey const &in_text_key, HPS::View const &in_view)
 
 AnnotationInsertedEvent (Event const &in_event)
 
EventClone () const
 
- Public Member Functions inherited from HPS::Event
virtual bool Drop (Event const *in_that_event) const
 
 Event (intptr_t in_channel=0)
 
virtual intptr_t Freshen () const
 
intptr_t GetChannel () const
 
intptr_t GetClassID () const
 
Time GetTimeStamp () const
 
bool IsConsumable () const
 

Public Attributes

SegmentKey text_key
 
View view
 

Additional Inherited Members

- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 
- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 
- Protected Attributes inherited from HPS::Event
intptr_t channel
 
bool consumable
 

Detailed Description

An event injected every time a new annotation is inserted. It contains the key of the segment containing the annotation and the view currently attached to this operator. This operator places each annotation in a separate segment.

Constructor & Destructor Documentation

◆ AnnotationInsertedEvent() [1/2]

HPS::AnnotationOperator::AnnotationInsertedEvent::AnnotationInsertedEvent ( )
inline

The default constructor creates an empty AnnotationInsertedEvent object.

◆ AnnotationInsertedEvent() [2/2]

HPS::AnnotationOperator::AnnotationInsertedEvent::AnnotationInsertedEvent ( Event const &  in_event)
inline

This constructor converts an Event Object to a MarkupInsertedEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::AnnotationOperator::AnnotationInsertedEvent::Clone ( ) const
inlinevirtual

Allocates and returns a copy of this AnnotationInsertedEvent.

Returns
A copy of this MarkupIAnnotationInsertedEventnsertedEvent.

Implements HPS::Event.


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