wfut  0.2.4
A client side C++ implementation of WFUT (WorldForge Update Tool).
WFUT::ChannelFileList Class Reference

#include <ChannelFileList.h>

Public Member Functions

std::string getName () const
 
void setName (const std::string &name)
 
const FileMap & getFiles () const
 
void addFile (const FileObject &fo)
 
void removeFile (const std::string &filename)
 
void clear ()
 
size_t size () const
 

Detailed Description

The ChannelFileList class represents a WFUT channel. It maintainns a list of FileObjects representing a local or remote directory of files.

Definition at line 17 of file ChannelFileList.h.

Member Function Documentation

◆ addFile()

void WFUT::ChannelFileList::addFile ( const FileObject fo)
inline

Adds a FileObject to this channel.

Definition at line 41 of file ChannelFileList.h.

Referenced by WFUT::WFUTClient::calculateUpdates().

◆ clear()

void WFUT::ChannelFileList::clear ( )
inline

Clear all the files out of the channel.

Definition at line 54 of file ChannelFileList.h.

◆ getFiles()

const FileMap& WFUT::ChannelFileList::getFiles ( ) const
inline

Get the FileMap object storing all of the FileObjects for this channel.

Definition at line 36 of file ChannelFileList.h.

Referenced by WFUT::WFUTClient::calculateUpdates(), and WFUT::WFUTClient::updateChannel().

◆ getName()

std::string WFUT::ChannelFileList::getName ( ) const
inline

Returns the name of the channel.

Definition at line 25 of file ChannelFileList.h.

Referenced by WFUT::WFUTClient::updateChannel().

◆ removeFile()

void WFUT::ChannelFileList::removeFile ( const std::string &  filename)
inline

Removes a FileObject from this channel by it's filename.

Definition at line 46 of file ChannelFileList.h.

◆ setName()

void WFUT::ChannelFileList::setName ( const std::string &  name)
inline

Set the name of the channel.

Definition at line 30 of file ChannelFileList.h.

◆ size()

size_t WFUT::ChannelFileList::size ( ) const
inline

Returns the number of files in the channel.

Definition at line 59 of file ChannelFileList.h.


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