Request for yield values using a development and optionally a graph vertex. More...

#include <FMTYieldRequest.h>

Inheritance diagram for Core::FMTYieldRequest:

Collaboration diagram for Core::FMTYieldRequest:

Public Types
typedef std::vector< std::pair< FMTMask, std::unique_ptr< FMTYieldHandler > > >::const_iterator	const_iterator

Public Member Functions
	FMTYieldRequest (const FMTDevelopment &ldevelopment, const Graph::FMTGraphVertexToYield &lgraphvertex)
	Construct a yield request from a development and a graph vertex.

	FMTYieldRequest (const FMTDevelopment &ldevelopment, const FMTYieldRequest &oldrequest)
	Construct a yield request from a development and a previous request.

	FMTYieldRequest (const FMTDevelopment &ldevelopment)
	Construct a yield request from a development, without reference to a graph.

	FMTYieldRequest ()=default
	Default constructor for FMTYieldRequest.

	FMTYieldRequest (const FMTYieldRequest &rhs)=default
	Copy constructor for FMTYieldRequest.

FMTYieldRequest &	operator= (const FMTYieldRequest &rhs)=default
	Copy assignment operator for FMTYieldRequest.

const FMTDevelopment &	getDevelopment () const
	Return the development of the request.

const std::vector< const_iterator > &	getDatas () const
	Return the yield data iterators of the request.

const Core::FMTMask &	getResumeMask () const
	Return the resume mask of the request.

const Graph::FMTGraphVertexToYield *	getVertexGraphInfo () const
	Return the graph vertex information of the request.

const_iterator	getFirstSeen (const std::string &p_yield) const
	Return the first data iterator for a given yield.

Public Member Functions inherited from Core::FMTObject
	FMTObject ()
	Default constructor for FMTObject.

virtual	~FMTObject ()
	Default virtual destructor for FMTObject.

	FMTObject (const std::unique_ptr< Exception::FMTExceptionHandler > exhandler)
	Construct a FMTObject passing in the exception handler of another FMTObject.

	FMTObject (const FMTObject &rhs)
	Copy constructor for FMTObject.

FMTObject &	operator= (const FMTObject &rhs)
	Copy assignment operator for FMTObject.

virtual void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger)
	Pass in the logger of another FMTObject.

void	passInExceptionHandler (const std::unique_ptr< Exception::FMTExceptionHandler > &exhandler)
	Pass in the exception handler of another FMTObject.

void	redirectLogToFile (const std::string &location)
	Redirect the log to a specific file, appending to it.

virtual void	setDefaultLogger ()
	Create and set a default logger to the FMTObject.

virtual void	setQuietLogger ()
	Create and set a quiet logger to the FMTObject.

virtual void	setTaskLogger ()
	Create and set a task logger to the FMTObject.

virtual void	setDebugLogger ()
	Create and set a debug logger to the FMTObject.

void	setDefaultExceptionHandler ()
	Create and set a default exception handler to the FMTObject.

void	setQuietExceptionHandler ()
	Create and set a quiet exception handler to the FMTObject.

void	setDebugExceptionHandler ()
	Create and set a debug exception handler to the FMTObject.

void	setFreeExceptionHandler ()
	Create and set a free exception handler to the FMTObject.

void	disableNestedExceptions ()
	Disable the nested exception throw of the exception handler.

void	enableNestedExceptions ()
	Enable the nested exception throw of the exception handler.

void	setErrorsToWarnings (const std::vector< Exception::FMTexc > &errors)
	Set a list of errors to be cast to warnings on the exception handler.

void	setMaxWarningsBeforeSilenced (const size_t &maxwarningcount)
	Set the number of warnings raised before being silenced.

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Friends
class	FMTYields

Additional Inherited Members
Static Public Member Functions inherited from Core::FMTObject
static Logging::FMTLogger *	getLogger ()
	get a pointer to the actual logger.

static Exception::FMTExceptionHandler *	getExceptionHandler ()
	get a pointer to the actual exception handler.

static std::string	getRuntimeLocation ()
	Return the location of the FMT shared library.

static unsigned long long	getAvailableMemory ()
	Return the available memory in bytes.

static void	setTerminateStack ()
	will write the stack in the log when terminate called and raise a function failed.

static void	setAbortStack ()
	will write the stack in the log when abort called with SIGABRT and raise a function failed.

Protected Member Functions inherited from Core::FMTObject
template<class Archive >
void	forceSave (Archive &ar, const unsigned int version) const
	Force the serialization to save useful information, which the default FMTObject serialization does not.

template<class Archive >
void	forceLoad (Archive &ar, const unsigned int version)
	Force the serialization to load useful information, which the default FMTObject serialization does not.

void	checkSignals () const
	Check if the user has sent a ctrl-c signal using boost::python to FMT.

void	setCplHandler ()
	Pass the FMT exception handler to the GDAL exception handler (GDAL only).

Static Protected Member Functions inherited from Core::FMTObject
static std::chrono::time_point< std::chrono::high_resolution_clock >	getClock ()
	Return a clock of the current time.

template<class chrono >
static double	getDuration (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock as a double.

static std::string	getDurationInSeconds (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock in seconds as a string.

static void	_logStack ()
	Log the stack trace...

static void	_terminate ()
	Raise an error with the boost stacktrace.

static void	_abort (int p_signal)
	Raise an error with the boost stacktrace on abort.

Static Protected Attributes inherited from Core::FMTObject
static std::unique_ptr< Exception::FMTExceptionHandler >	_exhandler
	A shared pointer to the exception handler.

static std::unique_ptr< Logging::FMTLogger >	_logger
	A shared pointer to the logger.

Detailed Description

Request for yield values using a development and optionally a graph vertex.

The yield is calculated using the FMTYields class and the graph to locate the actual state of the development. A request can also be built without any reference to a graph.

Member Typedef Documentation

◆ const_iterator

typedef std::vector<std::pair<FMTMask,std::unique_ptr<FMTYieldHandler>>>::const_iterator Core::FMTYieldRequest::const_iterator

Constructor & Destructor Documentation

◆ FMTYieldRequest() [1/5]

Core::FMTYieldRequest::FMTYieldRequest	(	const FMTDevelopment &	ldevelopment,
		const Graph::FMTGraphVertexToYield &	lgraphvertex
	)

Construct a yield request from a development and a graph vertex.

Parameters

[in]	ldevelopment	the development.
[in]	lgraphvertex	the graph vertex to yield.

◆ FMTYieldRequest() [2/5]

Core::FMTYieldRequest::FMTYieldRequest	(	const FMTDevelopment &	ldevelopment,
		const FMTYieldRequest &	oldrequest
	)

Construct a yield request from a development and a previous request.

Parameters

[in]	ldevelopment	the development.
[in]	oldrequest	the previous request.

◆ FMTYieldRequest() [3/5]

Core::FMTYieldRequest::FMTYieldRequest ( const FMTDevelopment & ldevelopment )

Construct a yield request from a development, without reference to a graph.

Parameters

[in] ldevelopment the development.

◆ FMTYieldRequest() [4/5]

Core::FMTYieldRequest::FMTYieldRequest ( )

default

Default constructor for FMTYieldRequest.

◆ FMTYieldRequest() [5/5]

Core::FMTYieldRequest::FMTYieldRequest ( const FMTYieldRequest & rhs )

default

Copy constructor for FMTYieldRequest.

Parameters

[in] rhs the FMTYieldRequest to copy.

Member Function Documentation

◆ getDatas()

const std::vector< const_iterator > & Core::FMTYieldRequest::getDatas ( ) const

Return the yield data iterators of the request.

Returns: a const reference to the yield data iterators.

◆ getDevelopment()

const FMTDevelopment & Core::FMTYieldRequest::getDevelopment ( ) const

Return the development of the request.

Returns: a const reference to the development.

◆ getFirstSeen()

const_iterator Core::FMTYieldRequest::getFirstSeen ( const std::string & p_yield ) const

Return the first data iterator for a given yield.

Parameters

[in] p_yield the yield name.

Returns: the first data iterator for the yield.

◆ getResumeMask()

const Core::FMTMask & Core::FMTYieldRequest::getResumeMask ( ) const

Return the resume mask of the request.

Returns: a const reference to the resume mask.

◆ getVertexGraphInfo()

const Graph::FMTGraphVertexToYield * Core::FMTYieldRequest::getVertexGraphInfo ( ) const

Return the graph vertex information of the request.

Returns: a pointer to the graph vertex to yield.

◆ operator=()

FMTYieldRequest & Core::FMTYieldRequest::operator= ( const FMTYieldRequest & rhs )

default

Copy assignment operator for FMTYieldRequest.

Parameters

[in] rhs the FMTYieldRequest to copy.

Returns: a reference to this FMTYieldRequest.

Friends And Related Function Documentation

◆ FMTYields

friend class FMTYields

friend

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

D:/FMT/Include/FMTYieldRequest.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

Constructor & Destructor Documentation

◆ FMTYieldRequest() [1/5]

◆ FMTYieldRequest() [2/5]

◆ FMTYieldRequest() [3/5]

◆ FMTYieldRequest() [4/5]

◆ FMTYieldRequest() [5/5]

Member Function Documentation

◆ getDatas()

◆ getDevelopment()

◆ getFirstSeen()

◆ getResumeMask()

◆ getVertexGraphInfo()

◆ operator=()

Friends And Related Function Documentation

◆ FMTYields