VuoCompilerTriggerAction Class Reference

Description

The callback that executes when a trigger port on a node generates an event.

Public Member Functions
	VuoCompilerTriggerAction (VuoCompilerTriggerPort *port, VuoCompilerNode *node)
	Creates a trigger callback.
void	generateAllocation (Module *module)
	Generates code to allocate global variables for this trigger.
void	generateInitialization (Module *module, BasicBlock *block)
	Generates code to initialize the global variables for this trigger.
void	generateFinalization (Module *module, BasicBlock *block)
	Generates code to finalize the global variables for this trigger.
Function *	generateAsynchronousSubmissionToDispatchQueue (Module *module, BasicBlock *block, string identifier)
	Generates code to submit a task to this trigger's dispatch queue.
Function *	generateSynchronousSubmissionToDispatchQueue (Module *module, BasicBlock *block, string identifier)
	Generates code to submit a task to this trigger's dispatch queue.
Value *	generateDataValueDidChange (Module *module, BasicBlock *block, Function *triggerWorker)
	Generates code to handle the trigger's data value (if any) having changed.
GlobalVariable *	getPreviousDataVariable (void)
	Returns the variable that stores the most recent data value fired from this trigger, or NULL if the trigger is event-only.
Type *	getDataType (void)
	Returns the type of data associated with the trigger, or NULL if the trigger is event-only.
string	getIdentifier (void)
	Returns an identifier for this trigger.

Member Function Documentation

Function * VuoCompilerTriggerAction::generateAsynchronousSubmissionToDispatchQueue	(	Module *	module,
		BasicBlock *	block,
		string	identifier
	)

Generates code to submit a task to this trigger's dispatch queue.

Returns the worker function, which will be called by the dispatch queue to execute the task. The caller is responsible for filling in the body of the worker function.

Assumes block is inside the function associated with a VuoCompilerTriggerPort. Passes the argument of that function, if any, as the context which will be passed to the worker function.

Value * VuoCompilerTriggerAction::generateDataValueDidChange	(	Module *	module,
		BasicBlock *	block,
		Function *	triggerWorker
	)

Generates code to handle the trigger's data value (if any) having changed.

Returns

The trigger's new data value.

Function * VuoCompilerTriggerAction::generateSynchronousSubmissionToDispatchQueue	(	Module *	module,
		BasicBlock *	block,
		string	identifier
	)

Generates code to submit a task to this trigger's dispatch queue.

Returns the worker function, which will be called by the dispatch queue to execute the task. The caller is responsible for filling in the body of the worker function.

---

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

• compiler/VuoCompilerTriggerAction.hh
• compiler/VuoCompilerTriggerAction.cc