retdec-cpp
Public Member Functions | Protected Attributes | List of all members
retdec::Resource Class Referenceabstract

Base class of all resources. More...

#include <resource.h>

Inheritance diagram for retdec::Resource:
retdec::Analysis retdec::Decompilation

Public Member Functions

virtual ~Resource ()=0
 Destructs the resource. More...
 
Querying
std::string getId () const
 Returns the ID of the resource. More...
 
bool hasFinished ()
 Has the resource finished? More...
 
bool hasFinished () const noexcept
 Has the resource finished? More...
 
bool hasSucceeded ()
 Has the resource succeeded? More...
 
bool hasSucceeded () const noexcept
 Has the resource succeeded? More...
 
bool hasFailed ()
 Has the resource failed? More...
 
bool hasFailed () const noexcept
 Has the resource failed? More...
 
std::string getError ()
 Returns the error message (if any). More...
 
std::string getError () const
 Returns the error message (if any). More...
 
Disabled
 Resource (const Resource &)=delete
 
 Resource (Resource &&)=delete
 
Resourceoperator= (const Resource &)=delete
 
Resourceoperator= (Resource &&)=delete
 

Protected Attributes

std::unique_ptr< internal::ResourceImpl > pimpl
 Private implementation. More...
 

Detailed Description

Base class of all resources.

Constructor & Destructor Documentation

retdec::Resource::~Resource ( )
pure virtualdefault

Destructs the resource.

retdec::Resource::Resource ( const Resource )
delete
retdec::Resource::Resource ( Resource &&  )
delete

Member Function Documentation

std::string retdec::Resource::getError ( )

Returns the error message (if any).

The output from this function is meaningful only if hasFinished() returns true and hasFailed() returns true.

May access the API.

std::string retdec::Resource::getError ( ) const

Returns the error message (if any).

The output from this function is meaningful only if hasFinished() returns true and hasFailed() returns true.

Does not access the API.

std::string retdec::Resource::getId ( ) const

Returns the ID of the resource.

Does not access the API.

bool retdec::Resource::hasFailed ( )

Has the resource failed?

The output from this function is meaningful only if hasFinished() returns true.

May access the API.

bool retdec::Resource::hasFailed ( ) const
noexcept

Has the resource failed?

The output from this function is meaningful only if hasFinished() returns true.

Does not access the API.

bool retdec::Resource::hasFinished ( )

Has the resource finished?

May access the API.

bool retdec::Resource::hasFinished ( ) const
noexcept

Has the resource finished?

Does not access the API.

bool retdec::Resource::hasSucceeded ( )

Has the resource succeeded?

The output from this function is meaningful only if hasFinished() returns true.

May access the API.

bool retdec::Resource::hasSucceeded ( ) const
noexcept

Has the resource succeeded?

The output from this function is meaningful only if hasFinished() returns true.

Does not access the API.

Resource& retdec::Resource::operator= ( const Resource )
delete
Resource& retdec::Resource::operator= ( Resource &&  )
delete

Member Data Documentation

std::unique_ptr<internal::ResourceImpl> retdec::Resource::pimpl
protected

Private implementation.


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