Class to communicate with a RapidSequencer process. More...

Public Types

enum  RapidSequencerState
 Reflects the state of the RapidSequencer process.
 

Static Functions

static std::shared_ptr< RapidSequencerCreate (const char *_nodeName, Platform _platform)
 Create the connection object to communicate with the RapidSequencer process. The windows platform MUST be run with Administrator UAC permissions. More...
 

Functions

virtual bool ClearCompileStatus ()=0
 Clears the compile status. Use this after it has been read. More...
 
virtual std::string CommandlineOutputGet ()=0
 Returns the output from the command line. More...
 
virtual bool Compile (const char *_filePath, const char *_mainFunctionName=DEFAULT_MAINFUNCNAME)=0
 Compiles the RapidSequencer script at the location specified. More...
 
virtual GlobalVirtualMachine::CompileStatus CompileStatusGet () const =0
 Returns the compile status. More...
 
virtual std::string ConsoleOutputGet ()=0
 Returns the output from the console. This should be polled after compiling, while running (if expecting output), and after completion. More...
 
virtual bool CreateFunctionXML (long timeout_ms=1000)=0
 Create xml formatted file that has all plugins' functions info functions info : Name, Parameters, Return and Description. More...
 
virtual std::string FunctionXMLPathGet ()=0
 Get the path of xml formatted file that has all plugins' function names, paramters and return type. More...
 
virtual bool GlobalBoolDataGet (const char *global_name)=0
 Get the Boolean value of RapidSequencerGlobal via name. More...
 
virtual void GlobalBoolDataSet (const char *global_name, bool bool_value)=0
 Set the Boolean value of RapidSequencerGlobal. More...
 
virtual char GlobalCharDataGet (const char *global_name)=0
 Get the Char value of RapidSequencerGlobal via name. More...
 
virtual void GlobalCharDataSet (const char *global_name, char char_value)=0
 Set the Char value of RapidSequencerGlobal. More...
 
virtual uint32_t GlobalCountGet ()=0
 Get the count of RapidSequencerGlobals. More...
 
virtual double GlobalDoubleDataGet (const char *global_name)=0
 Get the Double value of RapidSequencerGlobal via name. More...
 
virtual void GlobalDoubleDataSet (const char *global_name, double double_value)=0
 Set the Double value of RapidSequencerGlobal. More...
 
virtual int16_t GlobalInt16DataGet (const char *global_name)=0
 Get the Int16 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalInt16DataSet (const char *global_name, int16_t int16_value)=0
 Set the Int16 value of RapidSequencerGlobal. More...
 
virtual int32_t GlobalInt32DataGet (const char *global_name)=0
 Get the Int32 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalInt32DataSet (const char *global_name, int32_t int32_value)=0
 Set the Int32 value of RapidSequencerGlobal. More...
 
virtual int64_t GlobalInt64DataGet (const char *global_name)=0
 Get the Int64 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalInt64DataSet (const char *global_name, int64_t int64_value)=0
 Set the Int64 value of RapidSequencerGlobal. More...
 
virtual const char const * GlobalNameGet (uint32_t global_index)=0
 Get the name of RapidSequencerGlobal via index. More...
 
virtual RSI::RapidSequencerAPI::RapidSequencerGlobalVariable::Type GlobalTypeGet (uint32_t global_index)=0
 Get the type of RapidSequencerGlobal via index. More...
 
virtual RSI::RapidSequencerAPI::RapidSequencerGlobalVariable::Type GlobalTypeGet (const char *global_name)=0
 Get the type of RapidSequencerGlobal via name. More...
 
virtual uint16_t GlobalUInt16DataGet (const char *global_name)=0
 Get the UInt16 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalUInt16DataSet (const char *global_name, uint16_t uint16_value)=0
 Set the Uint16 value of RapidSequencerGlobal. More...
 
virtual uint32_t GlobalUInt32DataGet (const char *global_name)=0
 Get the UInt32 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalUInt32DataSet (const char *global_name, uint32_t uint32_value)=0
 Set the Uint32 value of RapidSequencerGlobal. More...
 
virtual uint64_t GlobalUInt64DataGet (const char *global_name)=0
 Get the UInt64 value of RapidSequencerGlobal via name. More...
 
virtual void GlobalUInt64DataSet (const char *global_name, uint64_t uint64_value)=0
 Set the Uint64 value of RapidSequencerGlobal. More...
 
virtual bool ProcessShutdown (uint32_t ms_timeout=0)=0
 Shuts down the RapidSequencer process. The timeout parameter specifies how long to wait before returning. More...
 
virtual bool ProcessStart (const char *executible_path="", const char *rmp_node="", uint32_t ms_timeout=0)=0
 Starts the RapidSequencer process, based on the constor parameters. The timeout parameter specifies how long to wait before returning. More...
 
virtual RapidSequencerState ProcessStateGet ()=0
 Returns the state of the RapidSequencer process. Running is good. NotRunning after a start indicates an error, otherwise ProcessStart must be called. Error is an error. ProcessMismatch is very bad (please reproduce and contact RSI) More...
 
virtual bool QueuesStatusGet ()=0
 This will return the status of the messaging mechanism between this object and the RapidSequencer process, and will initialize the mechanism if it has not yet been done so. This call is used internally when making any process calls, and is therefore optional. You can call this as part of the initialization process to speed up the initial connection. More...
 
virtual RapidSequencerGlobalVariables RapidSequencerGlobalVariablesUpdate ()=0
 Get the list of RapidSequencerGlobals. More...
 
virtual bool Run (const char *_filePath, const char *_mainFunctionName=DEFAULT_MAINFUNCNAME)=0
 Compiles and runs the RapidSequencer script at the location specified. More...
 
virtual CommandlineResponse RunCommandLine (const char *_cmdline)=0
 Compiles and runs the code contained in _cmdline. More...
 
virtual GlobalVirtualMachine::ThreadStatus SequencerStatusGet () const =0
 Returns the state of the currently running thread. More...
 
virtual bool ShutdownRapidSequencer ()=0
 Shutdown the virtual machine runtime, but not the RapidSequencer process. There are very few use cases for this, you should probably call ProcessShutdown. More...
 
virtual bool StopThreads ()=0
 Stops all running threads. Does NOT shut down the sequencer. More...
 
virtual GlobalVirtualMachine::VirtualMachineStatus VirtualMachineStatusGet () const =0
 Returns the VirtualMachine status (the execution engine). More...
 

Description

Class to communicate with a RapidSequencer process.