SHAPER  9.12.0
ModelAPI_ComputePositionsMessage Class Reference

Message to ask compute the positions of parameters in the expression. More...

Inheritance diagram for ModelAPI_ComputePositionsMessage:
Inheritance graph

Public Member Functions

MODELAPI_EXPORT ModelAPI_ComputePositionsMessage (const Events_ID theID, const void *theSender=0)
 Creates an empty message. More...
 
virtual MODELAPI_EXPORT ~ModelAPI_ComputePositionsMessage ()
 The virtual destructor. More...
 
MODELAPI_EXPORT const std::wstring & expression () const
 Returns an expression stored in the message. More...
 
MODELAPI_EXPORT const std::wstring & parameter () const
 Returns a parameter name stored in the message. More...
 
MODELAPI_EXPORT void set (const std::wstring &theExpression, const std::wstring &theParameter)
 Sets an expression and parameter needed for computation. More...
 
MODELAPI_EXPORT void setPositions (const std::list< std::pair< int, int > > &thePositions)
 Sets the results of processing. More...
 
MODELAPI_EXPORT const std::list< std::pair< int, int > > & positions () const
 Returns the results of processing: position start and end indices. 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_ComputePositionsMessagesend (const std::wstring &theExpression, const std::wstring &theParameter, const void *theSender)
 Useful method that creates and sends the AttributeEvalMessage event Returns the message, processed, with the resulting fields filled. More...
 

Detailed Description

Message to ask compute the positions of parameters in the expression.

Constructor & Destructor Documentation

◆ ModelAPI_ComputePositionsMessage()

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

Creates an empty message.

◆ ~ModelAPI_ComputePositionsMessage()

ModelAPI_ComputePositionsMessage::~ModelAPI_ComputePositionsMessage ( )
virtual

The virtual destructor.

Member Function Documentation

◆ eventId()

static MODELAPI_EXPORT Events_ID& ModelAPI_ComputePositionsMessage::eventId ( )
inlinestatic

Static. Returns EventID of the message.

◆ send()

static MODELAPI_EXPORT std::shared_ptr<ModelAPI_ComputePositionsMessage> ModelAPI_ComputePositionsMessage::send ( const std::wstring &  theExpression,
const std::wstring &  theParameter,
const void *  theSender 
)
inlinestatic

Useful method that creates and sends the AttributeEvalMessage event Returns the message, processed, with the resulting fields filled.

◆ expression()

const std::wstring & ModelAPI_ComputePositionsMessage::expression ( ) const

Returns an expression stored in the message.

◆ parameter()

const std::wstring & ModelAPI_ComputePositionsMessage::parameter ( ) const

Returns a parameter name stored in the message.

◆ set()

void ModelAPI_ComputePositionsMessage::set ( const std::wstring &  theExpression,
const std::wstring &  theParameter 
)

Sets an expression and parameter needed for computation.

◆ setPositions()

void ModelAPI_ComputePositionsMessage::setPositions ( const std::list< std::pair< int, int > > &  thePositions)

Sets the results of processing.

◆ positions()

const std::list< std::pair< int, int > > & ModelAPI_ComputePositionsMessage::positions ( ) const

Returns the results of processing: position start and end indices.

◆ 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.