NDEVR
API Documentation
FileRequest

A FileRequest bundles format data as well as a particular file. More...

Collaboration diagram for FileRequest:
[legend]

Public Member Functions

 FileRequest ()
 Default constructor.
 FileRequest (const File &file)
 Constructs a FileRequest for the given file with an invalid format.
 FileRequest (const File &file, const FileFormat &format)
 Constructs a FileRequest for the given file and format.
bool operator!= (const FileRequest &request) const
 Checks inequality with another FileRequest by comparing file and format.
bool operator== (const FileRequest &request) const
 Checks equality with another FileRequest by comparing both file and format.

Public Attributes

File file
 The file path associated with this request.
FileFormat format
 The file format describing how to handle the file.

Detailed Description

A FileRequest bundles format data as well as a particular file.

Definition at line 100 of file FileFormat.h.

Constructor & Destructor Documentation

◆ FileRequest() [1/3]

FileRequest::FileRequest ( )
inline

Default constructor.

Creates a FileRequest with an invalid format and no file.

Definition at line 105 of file FileFormat.h.

References format.

Referenced by operator!=(), and operator==().

◆ FileRequest() [2/3]

FileRequest::FileRequest ( const File & file)
inline

Constructs a FileRequest for the given file with an invalid format.

Parameters
[in]fileThe file to associate with this request.

Definition at line 112 of file FileFormat.h.

References file, and format.

◆ FileRequest() [3/3]

FileRequest::FileRequest ( const File & file,
const FileFormat & format )
inline

Constructs a FileRequest for the given file and format.

Parameters
[in]fileThe file to associate with this request.
[in]formatThe FileFormat describing how to read or write the file.

Definition at line 121 of file FileFormat.h.

References file, and format.

Member Function Documentation

◆ operator!=()

bool FileRequest::operator!= ( const FileRequest & request) const
inline

Checks inequality with another FileRequest by comparing file and format.

Parameters
[in]requestThe FileRequest to compare against.
Returns
True if either the file or format differs.

Definition at line 139 of file FileFormat.h.

References FileRequest(), file, and format.

◆ operator==()

bool FileRequest::operator== ( const FileRequest & request) const
inline

Checks equality with another FileRequest by comparing both file and format.

Parameters
[in]requestThe FileRequest to compare against.
Returns
True if both the file and format match.

Definition at line 130 of file FileFormat.h.

References FileRequest(), file, and format.

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