anatomist  5.1.2
3D neuroimaging data viewer
anatomist::OutputEvent Class Reference

This class holds events to send to output streams so that external programs are notified when something happens in Anatomist. More...

#include <anatomist/processor/event.h>

Public Member Functions

 OutputEvent (const std::string &evname, carto::Object contents, bool allocIDs=true, const std::set< std::string > &discrimintantAttribs=std::set< std::string >())
 Builds an Event. More...
 
virtual ~OutputEvent ()
 
virtual void send ()
 sends the event to all output streams More...
 
std::string eventType () const
 
carto::Object contents () const
 

Protected Member Functions

 OutputEvent ()
 

Detailed Description

This class holds events to send to output streams so that external programs are notified when something happens in Anatomist.

Definition at line 45 of file event.h.

Constructor & Destructor Documentation

◆ OutputEvent() [1/2]

anatomist::OutputEvent::OutputEvent ( const std::string &  evname,
carto::Object  contents,
bool  allocIDs = true,
const std::set< std::string > &  discrimintantAttribs = std::set< std::string >() 
)

Builds an Event.

Parameters
evnameevent type
contentsevent attributes. Attributes beginning with a '_' (underscore), of types AObject*, AWindow*, Referential*, Transformation *, or containers types built on these types (list, set, vector ) are converted to IDs before the event is sent to an output stream.
allocIDsspecifies if new IDs must be generated for 'unnamed' objects or if the corresponding objects are ignored
discrimintantAttribsis a list of attributes that are mandatory for the event to be significant: if these attributes are all empty, the event is just not sent to the corresponding output stream

◆ ~OutputEvent()

virtual anatomist::OutputEvent::~OutputEvent ( )
virtual

◆ OutputEvent() [2/2]

anatomist::OutputEvent::OutputEvent ( )
protected

Member Function Documentation

◆ contents()

carto::Object anatomist::OutputEvent::contents ( ) const
inline

Definition at line 69 of file event.h.

◆ eventType()

std::string anatomist::OutputEvent::eventType ( ) const
inline

Definition at line 68 of file event.h.

◆ send()

virtual void anatomist::OutputEvent::send ( )
virtual

sends the event to all output streams


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