libimgdoc2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
imgdoc2::non_existing_item_exception Class Reference

Exception for signalling that an attempt was made to access an non existing metadata item. More...

#include <exceptions.h>

Inheritance diagram for imgdoc2::non_existing_item_exception:
imgdoc2::imgdoc2_exception

Public Member Functions

 non_existing_item_exception (const std::string &error_message, imgdoc2::dbIndex index)
 
 non_existing_item_exception (const char *error_message, imgdoc2::dbIndex index)
 
bool IsIndexValid () const
 
imgdoc2::dbIndex GetIndex () const
 
- Public Member Functions inherited from imgdoc2::imgdoc2_exception
 imgdoc2_exception (const char *error_message)
 

Detailed Description

Exception for signalling that an attempt was made to access an non existing metadata item.

Constructor & Destructor Documentation

◆ non_existing_item_exception() [1/2]

imgdoc2::non_existing_item_exception::non_existing_item_exception ( const std::string &  error_message,
imgdoc2::dbIndex  index 
)
inlineexplicit

Constructor which specifies the primary key of the non existing tile.

Parameters
error_messageMessage describing the error.
indexThe primary key of the non existing tile.

◆ non_existing_item_exception() [2/2]

imgdoc2::non_existing_item_exception::non_existing_item_exception ( const char *  error_message,
imgdoc2::dbIndex  index 
)
inlineexplicit

Constructor which specifies the primary key of the non existing tile.

Parameters
error_messageMessage describing the error.
indexThe primary key of the non existing tile.

Member Function Documentation

◆ GetIndex()

imgdoc2::dbIndex imgdoc2::non_existing_item_exception::GetIndex ( ) const
inline

Gets the primary key of the non existing item which was attempted to be accessed. Check non_existing_item_exception::IsIndexValid() whether this property is valid.

Returns
The index of the non existing item which was attempted to be accessed.

◆ IsIndexValid()

bool imgdoc2::non_existing_item_exception::IsIndexValid ( ) const
inline

Gets a boolean indicating whether the primary key of the faulty item access is valid.

Returns
True if the primary key is valid; false otherwise.

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