Unify Framework Lib 1.6.0
image_file_handler Namespace Reference

Functions

void set_image_meta_info (const std::string &key, const uic_ota::meta_t &meta_info)
 Setting image filename. More...
 
uic_ota::meta_t get_image_meta_info (const std::string &key)
 Get image meta info. More...
 
void remove_image_meta_info (const std::string &key)
 Remove image meta info. More...
 
bool check_if_meta_info_received (const std::string &key)
 Checks if meta info is received for image key. More...
 
void set_images_received_cached_filepath (const std::string &key, const std::string &filepath)
 Set image which is received and cache it. More...
 
std::string get_image_cached_filepath (const std::string &key)
 Get image which is received and cached. More...
 
bool is_image_received_and_cached (const std::string &key)
 Check if image is received and cached. More...
 
void clear_images_cache ()
 Clear out cache of images. More...
 

Function Documentation

◆ check_if_meta_info_received()

bool image_file_handler::check_if_meta_info_received ( const std::string &  key)

Checks if meta info is received for image key.

Parameters
keyimage key identifier.
Returns
if image meta info is recieved.

◆ clear_images_cache()

void image_file_handler::clear_images_cache ( )

Clear out cache of images.

◆ get_image_cached_filepath()

std::string image_file_handler::get_image_cached_filepath ( const std::string &  key)

Get image which is received and cached.

Parameters
keyimage key which is received and cached.
Returns
filepath for image.

◆ get_image_meta_info()

uic_ota::meta_t image_file_handler::get_image_meta_info ( const std::string &  key)

Get image meta info.

Parameters
keyimage key for getting meta info.
Returns
meta info structure of image.
Exceptions
std::invalid_argumentif meta info could not be found.

◆ is_image_received_and_cached()

bool image_file_handler::is_image_received_and_cached ( const std::string &  key)

Check if image is received and cached.

Parameters
keyimage key or search.
Returns
true if received and cached.

◆ remove_image_meta_info()

void image_file_handler::remove_image_meta_info ( const std::string &  key)

Remove image meta info.

Parameters
keyimage key removing meta info for.

◆ set_image_meta_info()

void image_file_handler::set_image_meta_info ( const std::string &  key,
const uic_ota::meta_t meta_info 
)

Setting image filename.

Parameters
keyimage key for setting image filename.
meta_infometa info to set

◆ set_images_received_cached_filepath()

void image_file_handler::set_images_received_cached_filepath ( const std::string &  key,
const std::string &  filepath 
)

Set image which is received and cache it.

Parameters
keyimage key which is received.
filepathfor image which is received.