API Guides > ConceptRT 3.x
InputOutputSystem Class Reference

Singleton node for Ios abstraction management. More...

Detailed Description

Singleton node for Ios abstraction management.

+ Inheritance diagram for InputOutputSystem:

Public Member Methods

void RegisterIoTechnology (BaseConceptFactory &factory)
 Register an Io Technology class. More...
 
IoTechnologyListGetIoTechnologyList ()
 Gets the Technologies List. More...
 
IoMappingGetIoMapping ()
 Gets the mapping List. More...
 
IReferenceList< InputOutput > & GetInputOutputList ()
 Gets the Ios List. More...
 
void ClearConfiguration ()
 Clears the configuration. More...
 
void LoadXmlConfiguration (Stream &stream, IMessageCollector *messages=NULL)
 Load the technologies and mappings configuration. More...
 
void LoadConfiguration (IDataStore &dataStore, IMessageCollector *messages=NULL)
 Load the technologies and mappings configuration. More...
 
void SaveConfiguration (IDataStore &dataStore)
 Save the technologies and mappings configuration. More...
 
void SaveXmlConfiguration (Stream &stream)
 Save the technologies and mappings configuration. More...
 
bool Map (IMessageCollector *messages=NULL)
 Map all Ios with the given configuration. More...
 
void GenerateTemplateMapping (IDataStore &dataStore)
 Generate a template of technologies and mappings configuration. More...
 
void GenerateXmlTemplateMapping (Stream &stream)
 Generate a template of technologies and mappings configuration. More...
 
void Activate ()
 Activate all IoTechnologies involed in the mappings. More...
 
void Deactivate ()
 Deactivate all IoTechnologies involed in the mappings. More...
 
bool IsConfigurationLoaded () const
 Query if the configuration is loaded. More...
 
bool IsMapped () const
 Query if the mapping has been a success. More...
 
void Invoke (const DynamicInvocationRequest &request, DynamicInvocationResult &result)
 Invokes the object fields and methods. More...
 

Static Public Member Functions

static bool GetSimulation ()
 Query if the simulation has been a activated on the InputOutputSystem (global simulation). More...
 
static void SetSimulation ()
 Activate simulation globally on the InputOutputSystem. More...
 
- Static Public Member Functions inherited from Singleton< InputOutputSystem >
static InputOutputSystemGetInstancePointer ()
 Gets the instance pointer. More...
 
static InputOutputSystemGetInstance ()
 Gets the instance. More...
 
static void DeleteInstance (bool allowNewCreation=false)
 Deletes the instance. More...
 
static bool IsCreated ()
 Query if the singleton instance has already been created. More...
 

Methods Documentation

void Activate ( )

Activate all IoTechnologies involed in the mappings.

Warning
Call order dependence : LoadConfiguration and Map must be done first.
void ClearConfiguration ( )

Clears the configuration.

void Deactivate ( )

Deactivate all IoTechnologies involed in the mappings.

void GenerateTemplateMapping ( IDataStore dataStore)

Generate a template of technologies and mappings configuration.

Parameters
dataStoreDataStore where to store.
RT Exceptions:

RT_ERROR_INTERNAL_IO_TYPE_MISSMATCH

RT_ERROR_INTERNAL_IO_TYPE_NAME_MISSMATCH

void GenerateXmlTemplateMapping ( Stream stream)

Generate a template of technologies and mappings configuration.

Parameters
streamStream where to write.
RT Exceptions:

RT_ERROR_INTERNAL_IO_TYPE_MISSMATCH

RT_ERROR_INTERNAL_IO_TYPE_NAME_MISSMATCH

IReferenceList<InputOutput>& GetInputOutputList ( )

Gets the Ios List.

Returns
The Ios list.
IoMapping& GetIoMapping ( )

Gets the mapping List.

Returns
The the mapping list.
IoTechnologyList& GetIoTechnologyList ( )

Gets the Technologies List.

Returns
The Technologies list.
static bool GetSimulation ( )
static

Query if the simulation has been a activated on the InputOutputSystem (global simulation).

Returns
True if it is yes, false if not.
void Invoke ( const DynamicInvocationRequest request,
DynamicInvocationResult result 
)
inlinevirtual

Invokes the object fields and methods.

Parameters
requestThe request.
result[in,out] The result.

Dynamic Invocation on IInvocable objects enables us to have remote access on published fields and methods.

Implements IInvocable.

bool IsConfigurationLoaded ( ) const

Query if the configuration is loaded.

Returns
True if it is loaded, false if not.
bool IsMapped ( ) const

Query if the mapping has been a success.

Returns
True if it is yes, false if not.
void LoadConfiguration ( IDataStore dataStore,
IMessageCollector messages = NULL 
)

Load the technologies and mappings configuration.

Parameters
dataStoreDatastore source content.
messages(Optional) Messages diagnostic. Default = NULL.
void LoadXmlConfiguration ( Stream stream,
IMessageCollector messages = NULL 
)

Load the technologies and mappings configuration.

Parameters
streamStream source of the Xml content.
messages(Optional) Messages diagnostic. Default = NULL.
bool Map ( IMessageCollector messages = NULL)

Map all Ios with the given configuration.

Parameters
messages(Optional) Messages diagnostic. Default = NULL.
Returns
True if success. False if not. In case of false see the message diagnostic.
Warning
Call order dependence : LoadConfiguration must be done first.
void RegisterIoTechnology ( BaseConceptFactory factory)

Register an Io Technology class.

Parameters
factoryThe Io Technology class factory.
void SaveConfiguration ( IDataStore dataStore)

Save the technologies and mappings configuration.

Parameters
dataStoreDatastore where to store.
void SaveXmlConfiguration ( Stream stream)

Save the technologies and mappings configuration.

Parameters
streamStream where to store.
static void SetSimulation ( )
static

Activate simulation globally on the InputOutputSystem.

Note
As the status of the program will not be anymore in accord with the reality, a restart is necessary to disable the simulation.