Free Electron
Public Types | Public Member Functions | List of all members
fe::ext::OrchestratorI Class Referenceabstract

Orchestrate signalling of SystemI components. More...

#include <OrchestratorI.h>

Inheritance diagram for fe::ext::OrchestratorI:
Inheritance graph
[legend]

Public Types

typedef std::function< void(const t_note_id &)> t_note_perform
 

Public Member Functions

virtual void perform (const char *a_label)=0
 Signal SystemI's appended on matching id. More...
 
virtual void perform (const t_note_id &a_note_id)=0
 
virtual t_note_id note_id (const char *a_label)=0
 
virtual t_note_id connect (SystemI *a_system, const char *a_label)=0
 
virtual t_note_id connect (sp< SystemI > a_system, const char *a_label)=0
 
virtual void append (sp< SystemI > a_system)=0
 Append a SystemI to be signaled. More...
 
virtual void datasetInitialize (sp< RecordGroup > a_rg_dataset)=0
 Initialize based on a dataset. More...
 
virtual sp< RecordGroupdataset (void)=0
 Get the dataset. More...
 
virtual void setDT (t_moa_real a_dt)=0
 Set time step. More...
 
virtual t_moa_real getDT (void)=0
 Get time step. More...
 
virtual void step (const t_step_mode &a_step_mode=e_step_dt, t_moa_real a_time=0.0)=0
 Step time. More...
 
virtual t_moa_real getTime (void)=0
 Get time. More...
 
virtual t_note_id connect (t_note_perform a_perform, const char *a_label)=0
 
template<class F , class S >
t_note_id connect (S *s, F &&f, const char *a_label)
 
virtual bool compile (void)=0
 Compile internal structures of systems. More...
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
String factoryName (void)
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setFactoryIndex (I32 a_factoryIndex)
 Set the library's factory index. More...
 
I32 factoryIndex (void)
 Get the library's factory index. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

Orchestrate signalling of SystemI components.

Member Function Documentation

◆ append()

virtual void fe::ext::OrchestratorI::append ( sp< SystemI a_system)
pure virtual

Append a SystemI to be signaled.

Implemented in fe::ext::Orchestrator.

◆ compile()

virtual bool fe::ext::OrchestratorI::compile ( void  )
pure virtual

Compile internal structures of systems.

Implemented in fe::ext::Orchestrator.

◆ dataset()

virtual sp<RecordGroup> fe::ext::OrchestratorI::dataset ( void  )
pure virtual

Get the dataset.

Implemented in fe::ext::Orchestrator.

◆ datasetInitialize()

virtual void fe::ext::OrchestratorI::datasetInitialize ( sp< RecordGroup a_rg_dataset)
pure virtual

Initialize based on a dataset.

Implemented in fe::ext::Orchestrator.

◆ getDT()

virtual t_moa_real fe::ext::OrchestratorI::getDT ( void  )
pure virtual

Get time step.

Implemented in fe::ext::Orchestrator.

◆ getTime()

virtual t_moa_real fe::ext::OrchestratorI::getTime ( void  )
pure virtual

Get time.

Implemented in fe::ext::Orchestrator.

◆ perform()

virtual void fe::ext::OrchestratorI::perform ( const char *  a_label)
pure virtual

Signal SystemI's appended on matching id.

Implemented in fe::ext::Orchestrator.

◆ setDT()

virtual void fe::ext::OrchestratorI::setDT ( t_moa_real  a_dt)
pure virtual

Set time step.

Implemented in fe::ext::Orchestrator.

◆ step()

virtual void fe::ext::OrchestratorI::step ( const t_step_mode a_step_mode = e_step_dt,
t_moa_real  a_time = 0.0 
)
pure virtual

Step time.

Implemented in fe::ext::Orchestrator.


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