SHAPER  9.12.0
ModelAPI_BuildEvalMessage Class Reference
Inheritance diagram for ModelAPI_BuildEvalMessage:
Inheritance graph

Public Member Functions

MODELAPI_EXPORT ModelAPI_BuildEvalMessage (const Events_ID theID, const void *theSender=0)
 Creates an empty message. More...
 
virtual MODELAPI_EXPORT ~ModelAPI_BuildEvalMessage ()
 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 std::string &theError)
 Sets the results of processing. 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 bool isProcessed ()
 Returns true if the expression is processed. More...
 
MODELAPI_EXPORT const std::string & error () const
 Returns the interpreter error (empty if no error) More...
 
const Events_IDeventID () 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_IDeventId ()
 Static. Returns EventID of the message. More...
 
static MODELAPI_EXPORT std::shared_ptr< ModelAPI_BuildEvalMessagesend (FeaturePtr theParameter, const void *theSender)
 Useful method that creates and sends the event. More...
 

Constructor & Destructor Documentation

◆ ModelAPI_BuildEvalMessage()

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

Creates an empty message.

◆ ~ModelAPI_BuildEvalMessage()

ModelAPI_BuildEvalMessage::~ModelAPI_BuildEvalMessage ( )
virtual

The virtual destructor.

Member Function Documentation

◆ eventId()

static MODELAPI_EXPORT Events_ID& ModelAPI_BuildEvalMessage::eventId ( )
inlinestatic

Static. Returns EventID of the message.

◆ send()

static MODELAPI_EXPORT std::shared_ptr<ModelAPI_BuildEvalMessage> ModelAPI_BuildEvalMessage::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_BuildEvalMessage::parameter ( ) const

Returns a parameter stored in the message.

◆ setParameter()

void ModelAPI_BuildEvalMessage::setParameter ( FeaturePtr  theParam)

Sets a parameter to the message.

◆ setResults()

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

Sets the results of processing.

◆ params()

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

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

◆ isProcessed()

bool ModelAPI_BuildEvalMessage::isProcessed ( )

Returns true if the expression is processed.

◆ error()

const std::string & ModelAPI_BuildEvalMessage::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
inlineinherited

Returns sender of the message or NULL if it is anonymous message.