Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Static Public Member Functions | List of all members
ClarisseEngine Class Reference

This class allows you to create an instance of Clarisse in order to embbed it in an host application. Only one instance of Clarisse Engine is allowed by application. This means that if you quit use ClarisseEngineHandler::quit you won't able to create a new instance of the engine. When you create an instance of Clarisse Engine, it creates an instance of Clarisse application running in a background thread attached to the current process. More...

Static Public Member Functions

static bool is_created ()
 Return true if Clarisse Engine is running in the background.
 
static ClarisseEngineHandlercreate (int argc, char **argv, const char *module_path)
 Create an instance of Clarisse Engine.
 
static ClarisseEngineHandlercreate (int argc, char **argv, const CoreBasicArray< CoreString > &module_paths)
 Create an instance of Clarisse Engine.
 
static ClarisseEngineHandlerget_engine ()
 Return the instance of Clarisse Engine.
 

Detailed Description

This class allows you to create an instance of Clarisse in order to embbed it in an host application. Only one instance of Clarisse Engine is allowed by application. This means that if you quit use ClarisseEngineHandler::quit you won't able to create a new instance of the engine. When you create an instance of Clarisse Engine, it creates an instance of Clarisse application running in a background thread attached to the current process.

Note
Embedding Clarisse Engine in 3rd party applications requires a special license agreement. Please contact sales.nosp@m.@iso.nosp@m.tropi.nosp@m.x.co.nosp@m.m for more information.

Member Function Documentation

ClarisseEngineHandler * ClarisseEngine::create ( int  argc,
char **  argv,
const char *  module_path 
)
static

Create an instance of Clarisse Engine.

Parameters
argccommand line argc passed to Clarisse application
argvcommand line argv passed to Clarisse application
module_pathPath to where Clarisse modules are located.
Note
There can be only a single instance of Clarisse Engine running at the time. argc and argv can be used to pass arguments you would normally pass to CNode.
ClarisseEngineHandler * ClarisseEngine::create ( int  argc,
char **  argv,
const CoreBasicArray< CoreString > &  module_paths 
)
static

Create an instance of Clarisse Engine.

Parameters
argccommand line argc passed to Clarisse application
argvcommand line argv passed to Clarisse application
module_pathPath to where Clarisse modules are located.
Note
There can be only a single instance of Clarisse Engine running at the time. argc and argv can be used to pass arguments you would normally pass to CNode.
ClarisseEngineHandler * ClarisseEngine::get_engine ( )
static

Return the instance of Clarisse Engine.

Note
You must first call ClarisseEngine::create before calling this method. If no Clarisse Engine has been created, ClarisseEngine::get_engine returns NULL.