HPS::ImportStatusEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::ImportStatusEvent:

Public Member Functions

EventClone () const
 ImportStatusEvent ()
ImportStatusEvent (char const *in_message)
 ImportStatusEvent (Event const &in_event)
- 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

HPS::UTF8 import_status_message

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

The ImportStatusEvent class is the event that can be used by importers to let the user know what they are currently working on

Constructor & Destructor Documentation

◆ ImportStatusEvent() [1/2]

HPS::ImportStatusEvent::ImportStatusEvent ( )

The default constructor creates a ImportStatusEvent.

◆ ImportStatusEvent() [2/2]

HPS::ImportStatusEvent::ImportStatusEvent ( Event const &  in_event)

This constructor converts an Event Object to an ImportStatusEvent object.

in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::ImportStatusEvent::Clone ( ) const

Allocates and returns a copy of this ImportStatusEvent.

A copy of this ImportStatusEvent.

Implements HPS::Event.

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