Arguments for analyses. More...

#include <analysis_arguments.h>

Inheritance diagram for retdec::AnalysisArguments:

Public Member Functions
Construction, Assignment, and Destruction
	AnalysisArguments ()
	Constructs default arguments. More...

	AnalysisArguments (const AnalysisArguments &other)
	Copy-constructs arguments from the given arguments. More...

	AnalysisArguments (AnalysisArguments &&other)
	Move-constructs arguments from the given arguments. More...

AnalysisArguments &	operator= (const AnalysisArguments &other)
	Copy-assigns the given arguments. More...

AnalysisArguments &	operator= (AnalysisArguments &&other)
	Move-assigns the given arguments. More...

	~AnalysisArguments ()
	Destructs the arguments. More...

Verbose
AnalysisArguments &	verbose (const std::string &verbose)
	Sets the verbose mode. More...

AnalysisArguments	withVerbose (const std::string &verbose) const
	Returns a copy of the arguments with a verbose mode. More...

bool	hasVerbose () const
	Is the verbose argument set? More...

std::string	verbose () const
	Should the analysis be run in the verbose mode? More...

Input File
AnalysisArguments &	inputFile (const std::shared_ptr< File > &file)
	Sets the input file. More...

AnalysisArguments	withInputFile (const std::shared_ptr< File > &file) const
	Returns a copy of the arguments with a different input file. More...

bool	hasInputFile () const
	Is the input file set? More...

std::shared_ptr< File >	inputFile () const
	Returns the input file. More...

Generic Access To Arguments
AnalysisArguments &	argument (const std::string &id, const std::string &value)
	Sets the argument of the given ID to the given value. More...

AnalysisArguments	withArgument (const std::string &id, const std::string &value) const
	Returns a copy of the arguments with a differing argument of the given ID. More...

Generic Access To Files
AnalysisArguments &	file (const std::string &id, const std::shared_ptr< File > &file)
	Sets the file of the given ID to the given value. More...

AnalysisArguments	withFile (const std::string &id, const std::shared_ptr< File > &file) const
	Returns a copy of the files with a differing file of the given ID. More...

Public Member Functions inherited from retdec::ResourceArguments
	ResourceArguments ()
	Constructs default arguments. More...

	ResourceArguments (const ResourceArguments &other)
	Copy-constructs arguments from the given arguments. More...

	ResourceArguments (ResourceArguments &&other)
	Move-constructs arguments from the given arguments. More...

ResourceArguments &	operator= (const ResourceArguments &other)
	Copy-assigns the given arguments. More...

ResourceArguments &	operator= (ResourceArguments &&other)
	Move-assigns the given arguments. More...

	~ResourceArguments ()
	Destructs the arguments. More...

ResourceArguments &	argument (const std::string &id, const std::string &value)
	Sets the argument of the given ID to the given value. More...

ResourceArguments	withArgument (const std::string &id, const std::string &value) const
	Returns a copy of the arguments with a differing argument of the given ID. More...

bool	hasArgument (const std::string &id) const
	Is an argument of the given ID present? More...

std::string	argument (const std::string &id) const
	Returns the value of the given argument. More...

ArgumentIterator	argumentsBegin () const
	Returns an iterator to the beginning of arguments. More...

ArgumentIterator	argumentsEnd () const
	Returns an iterator past the last argument. More...

ResourceArguments &	file (const std::string &id, const std::shared_ptr< File > &file)
	Sets the file of the given ID to the given value. More...

ResourceArguments	withFile (const std::string &id, const std::shared_ptr< File > &file) const
	Returns a copy of the files with a differing file of the given ID. More...

bool	hasFile (const std::string &id) const
	Is a file of the given ID present? More...

std::shared_ptr< File >	file (const std::string &id) const
	Returns the file of the given ID. More...

FileIterator	filesBegin () const
	Returns an iterator to the beginning of arguments. More...

FileIterator	filesEnd () const
	Returns an iterator past the last argument. More...

Additional Inherited Members
Public Types inherited from retdec::ResourceArguments
using	ArgumentIterator = Arguments::const_iterator
	Iterator for arguments. More...

using	FileIterator = Files::const_iterator
	Iterator for files. More...

Protected Attributes inherited from retdec::ResourceArguments
Arguments	arguments
	Arguments. More...

Files	files
	Files. More...

Detailed Description

Arguments for analyses.

Constructor & Destructor Documentation

retdec::AnalysisArguments::AnalysisArguments ( )

default

Constructs default arguments.

retdec::AnalysisArguments::AnalysisArguments ( const AnalysisArguments & other )

default

Copy-constructs arguments from the given arguments.

retdec::AnalysisArguments::AnalysisArguments ( AnalysisArguments && other )

default

Move-constructs arguments from the given arguments.

retdec::AnalysisArguments::~AnalysisArguments ( )

default

Destructs the arguments.

Member Function Documentation

AnalysisArguments & retdec::AnalysisArguments::argument	(	const std::string &	id,
		const std::string &	value
	)

Sets the argument of the given ID to the given value.

AnalysisArguments & retdec::AnalysisArguments::file	(	const std::string &	id,
		const std::shared_ptr< File > &	file
	)

Sets the file of the given ID to the given value.

bool retdec::AnalysisArguments::hasInputFile ( ) const

Is the input file set?

bool retdec::AnalysisArguments::hasVerbose ( ) const

Is the verbose argument set?

It returns true even when verbose was explicitly set to "no". It only returns false when the verbose argument was not set.

AnalysisArguments & retdec::AnalysisArguments::inputFile ( const std::shared_ptr< File > & file )

Sets the input file.

std::shared_ptr< File > retdec::AnalysisArguments::inputFile ( ) const

Returns the input file.

AnalysisArguments & retdec::AnalysisArguments::operator= ( const AnalysisArguments & other )

default

Copy-assigns the given arguments.

AnalysisArguments & retdec::AnalysisArguments::operator= ( AnalysisArguments && other )

default

Move-assigns the given arguments.

AnalysisArguments & retdec::AnalysisArguments::verbose ( const std::string & verbose )

Sets the verbose mode.

When verbose is "yes", the analysis produces all the supported information about the input file. Otherwise, when verbose is "no" (the default), the analysis produces only basic information.

std::string retdec::AnalysisArguments::verbose ( ) const

Should the analysis be run in the verbose mode?

AnalysisArguments retdec::AnalysisArguments::withArgument	(	const std::string &	id,
		const std::string &	value
	)		const

Returns a copy of the arguments with a differing argument of the given ID.

AnalysisArguments retdec::AnalysisArguments::withFile	(	const std::string &	id,
		const std::shared_ptr< File > &	file
	)		const

Returns a copy of the files with a differing file of the given ID.

AnalysisArguments retdec::AnalysisArguments::withInputFile ( const std::shared_ptr< File > & file ) const

Returns a copy of the arguments with a different input file.

AnalysisArguments retdec::AnalysisArguments::withVerbose ( const std::string & verbose ) const

Returns a copy of the arguments with a verbose mode.

See the description of verbose(const std::string &verbose) for more details.

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

/home/s3rvac/Projects/GitHub/Created/retdec-cpp/include/retdec/analysis_arguments.h
/home/s3rvac/Projects/GitHub/Created/retdec-cpp/src/retdec/analysis_arguments.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation