Message that parameter feature expression should be evaluated: value and error producing. More...

Inheritance diagram for ModelAPI_ParameterEvalMessage:

Public Member Functions
MODELAPI_EXPORT	ModelAPI_ParameterEvalMessage (const Events_ID theID, const void *theSender=0)
	Creates an empty message. More...

virtual MODELAPI_EXPORT	~ModelAPI_ParameterEvalMessage ()
	The virtual destructor. More...

MODELAPI_EXPORT FeaturePtr	parameter () const
	Returns a parameter stored in the message. More...

MODELAPI_EXPORT void	setParameter (FeaturePtr theParam)
	Sets a parameter to the message. More...

MODELAPI_EXPORT void	setResults (const std::list< std::shared_ptr< ModelAPI_ResultParameter > > &theParamsList, const double theResult, const std::string &theError)
	Sets the results of processing. More...

MODELAPI_EXPORT bool	isProcessed ()
	Returns true if the expression is processed. More...

MODELAPI_EXPORT const std::list< std::shared_ptr< ModelAPI_ResultParameter > > &	params () const
	Returns the results of processing: list of parameters found in the expression. More...

MODELAPI_EXPORT const double &	result () const
	Returns the expression result. More...

MODELAPI_EXPORT const std::string &	error () const
	Returns the interpreter error (empty if no error) More...

const Events_ID &	eventID () const
	Returns identifier of the message. More...

void *	sender () const
	Returns sender of the message or NULL if it is anonymous message. More...

Static Public Member Functions
static MODELAPI_EXPORT Events_ID &	eventId ()
	Static. Returns EventID of the message. More...

static MODELAPI_EXPORT std::shared_ptr< ModelAPI_ParameterEvalMessage >	send (FeaturePtr theParameter, const void *theSender)
	Useful method that creates and sends the event. More...

Detailed Description

Message that parameter feature expression should be evaluated: value and error producing.

Constructor & Destructor Documentation

◆ ModelAPI_ParameterEvalMessage()

ModelAPI_ParameterEvalMessage::ModelAPI_ParameterEvalMessage	(	const Events_ID	theID,
		const void *	theSender = `0`
	)

Creates an empty message.

◆ ~ModelAPI_ParameterEvalMessage()

ModelAPI_ParameterEvalMessage::~ModelAPI_ParameterEvalMessage ( )

virtual

The virtual destructor.

Member Function Documentation

◆ eventId()

static MODELAPI_EXPORT Events_ID& ModelAPI_ParameterEvalMessage::eventId ( )

inlinestatic

Static. Returns EventID of the message.

◆ send()

static MODELAPI_EXPORT std::shared_ptr<ModelAPI_ParameterEvalMessage> ModelAPI_ParameterEvalMessage::send	(	FeaturePtr	theParameter,
		const void *	theSender
	)

inlinestatic

Useful method that creates and sends the event.

Returns the message, processed, with the resulting fields filled.

◆ parameter()

FeaturePtr ModelAPI_ParameterEvalMessage::parameter ( ) const

Returns a parameter stored in the message.

◆ setParameter()

void ModelAPI_ParameterEvalMessage::setParameter ( FeaturePtr theParam )

Sets a parameter to the message.

◆ setResults()

void ModelAPI_ParameterEvalMessage::setResults	(	const std::list< std::shared_ptr< ModelAPI_ResultParameter > > &	theParamsList,
		const double	theResult,
		const std::string &	theError
	)

Sets the results of processing.

◆ isProcessed()

bool ModelAPI_ParameterEvalMessage::isProcessed ( )

Returns true if the expression is processed.

◆ params()

const std::list< std::shared_ptr< ModelAPI_ResultParameter > > & ModelAPI_ParameterEvalMessage::params ( ) const

Returns the results of processing: list of parameters found in the expression.

◆ result()

const double & ModelAPI_ParameterEvalMessage::result ( ) const

Returns the expression result.

◆ error()

const std::string & ModelAPI_ParameterEvalMessage::error ( ) const

Returns the interpreter error (empty if no error)

◆ eventID()

const Events_ID& Events_Message::eventID ( ) const

inlineinherited

Returns identifier of the message.

◆ sender()

void* Events_Message::sender ( ) const