Kanzi Connect  3.9.9
Kanzi Connect C++ API
kanzi::connect::FileSet Class Reference

Container for set of file items. More...

#include <fileset.hpp>

Public Member Functions

void add (const FileSetItem &item)
 Inserts a new item. More...
 
const FileSetItemat (size_t index) const
 Retrieves item at specifiec index. More...
 
FileSetclone ()
 Creates a duplicate of the fileset. More...
 
bool contains (const string &filename)
 Check whether contains an file with the specified name. More...
 
size_t count () const
 Return amount of items held. More...
 
const FileSetItemget (const string &filename)
 Retrieves item with filename. More...
 

Detailed Description

Container for set of file items.

Member Function Documentation

◆ add()

void kanzi::connect::FileSet::add ( const FileSetItem item)

Inserts a new item.

Parameters
itemto be inserted.

◆ at()

const FileSetItem& kanzi::connect::FileSet::at ( size_t  index) const

Retrieves item at specifiec index.

Parameters
indexthe index
Returns
item

◆ clone()

FileSet* kanzi::connect::FileSet::clone ( )

Creates a duplicate of the fileset.

Returns
newly allocated fileset with exactly same content. ownership transfers.

◆ contains()

bool kanzi::connect::FileSet::contains ( const string &  filename)

Check whether contains an file with the specified name.

Parameters
filenamethe name to be checked.

◆ count()

size_t kanzi::connect::FileSet::count ( ) const

Return amount of items held.

Returns
the count items.

◆ get()

const FileSetItem& kanzi::connect::FileSet::get ( const string &  filename)

Retrieves item with filename.

Parameters
filenamethe item to retrieve.
Returns
item

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