NZBGetFacadeInfo documentation.

NZBGetFacadeInfo methods.

constructor

NZBFacadeInfo()

NZBFacadeInfo default constructor.

variables
none
none
returns
none
none

setId

void setId(int id)

Set the id of the info contained in this object.

variables
id
The id to set.
returns
void
none

setFileNZBName

void setFileNZBName(const std::string name)

Set the name of the NZB file contained in this object.

variables
name
File name of the NZB file
returns
void
none

setNiceNZBName

void setNiceNZBName(const std::string name)

Set the display name of the NZB file

variables
name
Display name of the NZB file.
returns
void
none

setCategory

void setCategory(const std::string category)

Set the NZB category

variables
category
The NZB category
returns
void
none

setFileCount

void setFileCount(int count)

Set the number of files contained in the NZB.

variables
count
Number of files in the NZB.
returns
void
none

setCompletedFileCount

void setCompletedFileCount(int count)

Set thu number of files in the NZB that have completely been downloaded.

variables
count
The number of files in NZB that have completed downloading.
returns
void
none

setSize

void setSize(size_t lNZBSize)

Set total size of files contained in NZB.

variables
lNZBSize
Total size in bytes.
returns
void
none

AddFileList

void AddFileList(NZBFacadeFile *pFacadeFile)

Add a file object to this object.

variables
pFacadeFile
Pointer to file object.
returns
void
none

getId

int getId() const

Get the NZB id

variables
none
none
returns
int
NZB id in libNZBGet.

getFileNZBName

const std::string &getFileNZBName() const

Get the file name af the NZB file.

variables
none
none
returns
const std::string
String containing the NZB file name.

getNiceNZBName

const std::string &getNiceNZBName() const

Get the display name of the NZB.

variables
none
none
returns
const std::string
String holding the display name of the NZB.

getCategory

const std::string &getCategory() const

Get the NZB file category.

variables
none
none
returns
const std::string
NZB file category.

getFileCount

int getFileCount() const

Get the number of files contained in the NZB file.

variables
none
none
returns
int
Number of files.

getCompletedFileCount

int getCompletedFileCount() const

Get the number of files that are completely downloaded.

variables
none
none
returns
int
number of completed files.

getSize

size_t getSize() const

Get the total size of all files contained in the NZB.

variables
none
none
returns
size_t
Total filesize in bytes.

getFileList

const NZBFacadeFileList *getFileList() const

Get the files contained in the NZB file.

variables
none
none
returns
const NZBFacadeFileList*
List of objects holding information on the files contained in the NZB file.

getRemainingSize

size_t getRemainingSize() const

Get the remaining size to be downloaded.

variables
none
none
returns
size_t
Size to be downloaded in bytes.