The Vish Visualization Shell 0.3
Vish
Public Member Functions | List of all members
MemCore::LoaderProgress Class Reference

A base class for callbacks during the load process. More...

#include <elementary/memcore/Loader.hpp>

Inheritance diagram for MemCore::LoaderProgress:
MemCore::Interface< LoaderProgress > MemCore::InterfaceBase MemCore::ReferenceBase< InterfaceBase >

Public Member Functions

virtual bool abort_on_issue (const string &what)
 Callback function for the case something happened during loading.
 
 LoaderProgress ()
 Constructor.
 
virtual bool OpenFile (const string &fname)
 Notification of opening a file.
 
virtual bool tryLoader (const WeakPtrLoaderBase &WhichLoader, const type_info &LoadWhat, int loadernumber, int howmanyloaders)
 Callback function telling which loader is currently tried to load a specific source.
 
- Public Member Functions inherited from MemCore::Interface< LoaderProgress >
const type_info & getInterfaceDomain () const
 Run-time information about the type used for InterCube registration.
 
- Public Member Functions inherited from MemCore::InterfaceBase
virtual bool apply (Intercube &I, const RefPtr< InterfaceIterationParameter > &)
 modifyable callback function
 
virtual bool apply_const (const Intercube &I, const RefPtr< InterfaceIterationParameter > &)
 constant callback function
 
 InterfaceBase () throw ()
 Constructor.
 
- Public Member Functions inherited from MemCore::ReferenceBase< InterfaceBase >
auto getObjectCountID () const noexcept
 Get a unique ID for this object in the given domain.
 
bool isIdentical (const WeakPtr< InterfaceBase, InterfaceBase > &PossibleSelf) const noexcept
 Check if this object is identical to the one used by the given pointer.
 
void mkAutoDestructive ()
 Marks this object as being automatically destructed, e.g.
 
refcount_t refcount () const noexcept
 The strong reference count.
 
 ReferenceBase (InterfaceBase *that) noexcept
 Constructor, initializes reference counter to zero.
 
const auto & self () const
 Return weak pointer to the object self.
 
refcount_t wrefcount () const noexcept
 The weak reference count.
 

Additional Inherited Members

- Public Types inherited from MemCore::Interface< LoaderProgress >
using InterfaceDomain_t = LoaderProgress
 Compile-time information about the type used for InterCube registration.
 
- Public Types inherited from MemCore::ReferenceBase< InterfaceBase >
using reference_domain_t = InterfaceBase
 The type of the base class.
 
using SelfPtr_t = WeakPtr< InterfaceBase, InterfaceBase >
 Type for a pointer to this object itself.
 
- Protected Member Functions inherited from MemCore::InterfaceBase
 ~InterfaceBase ()
 Destructor.
 
- Protected Member Functions inherited from MemCore::ReferenceBase< InterfaceBase >
virtual void extremeUnction ()
 A virtual function that will be called just before the object is destroyed.
 
ReferenceBaseoperator= (const ReferenceBase &R)
 Protected assignment operator (should not be called).
 
void suicide ()
 Delete this.
 
virtual ~ReferenceBase ()
 Virtual destructor.
 

Detailed Description

A base class for callbacks during the load process.

,LoaderRegistry

Member Function Documentation

◆ abort_on_issue()

bool MemCore::LoaderProgress::abort_on_issue ( const string &  what)
virtual

Callback function for the case something happened during loading.

If this function returns true, then loading will be terminated, otherwise the issue will be ignored.

◆ tryLoader()

bool MemCore::LoaderProgress::tryLoader ( const WeakPtrLoaderBase WhichLoader,
const type_info &  LoadWhat,
int  loadernumber,
int  howmanyloaders 
)
virtual

Callback function telling which loader is currently tried to load a specific source.

If it returns false, then the provided loader will not be used and the process of loading continues to look for another loader.