CMSDK 2.0.1
Cross-platform C++ base library and SDK for the Psyclone AIOS platform
Loading...
Searching...
No Matches
cmsdk3.PsyAPI Class Reference
Inheritance diagram for cmsdk3.PsyAPI:
[legend]
Collaboration diagram for cmsdk3.PsyAPI:
[legend]

Public Member Functions

 __init__ (self, space)
 setAutoDelete (self, autodel)
 isRunning (self)
 shouldContinue (self)
 getCommandlineBasedir (self)
 setCommandlineBasedir (self, cmdlineBasedir)
 getModuleName (self, *args)
 getOtherModuleName (self, id)
 getInputQueueSize (self)
 typeToText (self, type)
 contextToText (self, context)
 getCurrentScriptLanguage (self, *args)
 getCurrentScript (self, *args)
 getCurrentScriptFilename (self, *args)
 getCurrentPostNames (self)
 hasCurrentSignalName (self, name)
 hasCurrentQueryName (self, name)
 hasCurrentRetrieveName (self, name)
 hasCurrentPostName (self, name)
 waitForNewMessageGroup (self, ms, groupName)
 getCurrentTriggerName (self)
 getCurrentTriggerContext (self)
 waitForNewMessage (self, *args)
 getCurrentMessageReceiveTime (self)
 postOutputMessage (self, *args)
 emitSignal (self, name, msg=None)
 waitForSignal (self, name, timeout, lastReceivedTime=0)
 retrieveAllSystemIDs (self)
 addSubscription (self, xml)
 addPsyProbeCustomView (self, name, templateURL)
 removePsyProbeCustomView (self, name)
 setPrivateData (self, name, data, size, mimetype=None)
 getPrivateDataSize (self, name)
 getPrivateDataCopy (self, name, size)
 getPrivateData (self, name, data, maxSize)
 deletePrivateData (self, name)
 createParameter (self, *args)
 hasParameter (self, name)
 deleteParameter (self, name)
 getParameterDataType (self, name)
 getParameterValueSize (self, name)
 getParameterString (self, name)
 getParameterAsBool (self, name)
 getParameterInt (self, name)
 getParameterFloat (self, name)
 getParameter (self, *args)
 setParameter (self, *args)
 resetParameter (self, name)
 tweakParameter (self, name, tweak)
 retrieveTimeParam (self, result, name, startTime, endTime=0, maxcount=0, maxage=0, timeout=5000)
 retrieveStringParam (self, result, name, startString, endString=None, maxcount=0, maxage=0, timeout=5000)
 retrieveIntegerParam (self, *args)
 retrieveFloatParam (self, result, name, startFloat, endFloat=0.123456789123456789, maxcount=0, maxage=0, timeout=5000)
 retrieve (self, *args)
 queryCatalog (self, *args)
 queryRemoteCatalog (self, *args)
 queryReply (self, *args)
 logPrint (self, level, formatstring)

Static Public Member Functions

 fromPython (ptr)
 fromPythonAddressOf (ptr)

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 CTRL_SYSTEM_READY = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_READY_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_READY_set)
 CTRL_PROCESS_INITIALISE = property(_cmsdk3.PsyAPI_CTRL_PROCESS_INITIALISE_get, _cmsdk3.PsyAPI_CTRL_PROCESS_INITIALISE_set)
 CTRL_PROCESS_GREETING = property(_cmsdk3.PsyAPI_CTRL_PROCESS_GREETING_get, _cmsdk3.PsyAPI_CTRL_PROCESS_GREETING_set)
 CTRL_PROCESS_SHUTDOWN = property(_cmsdk3.PsyAPI_CTRL_PROCESS_SHUTDOWN_get, _cmsdk3.PsyAPI_CTRL_PROCESS_SHUTDOWN_set)
 CTRL_CONTEXT_CHANGE = property(_cmsdk3.PsyAPI_CTRL_CONTEXT_CHANGE_get, _cmsdk3.PsyAPI_CTRL_CONTEXT_CHANGE_set)
 CTRL_SYSTEM_SHUTDOWN = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTDOWN_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTDOWN_set)
 CTRL_SYSTEM_SHUTTINGDOWN = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTTINGDOWN_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTTINGDOWN_set)
 CTRL_TRIGGER = property(_cmsdk3.PsyAPI_CTRL_TRIGGER_get, _cmsdk3.PsyAPI_CTRL_TRIGGER_set)
 CTRL_TRIGGER_GROUP = property(_cmsdk3.PsyAPI_CTRL_TRIGGER_GROUP_get, _cmsdk3.PsyAPI_CTRL_TRIGGER_GROUP_set)
 CTRL_QUERY = property(_cmsdk3.PsyAPI_CTRL_QUERY_get, _cmsdk3.PsyAPI_CTRL_QUERY_set)
 CTRL_QUERY_REPLY = property(_cmsdk3.PsyAPI_CTRL_QUERY_REPLY_get, _cmsdk3.PsyAPI_CTRL_QUERY_REPLY_set)
 CTRL_PULLCOMPONENTDATA = property(_cmsdk3.PsyAPI_CTRL_PULLCOMPONENTDATA_get, _cmsdk3.PsyAPI_CTRL_PULLCOMPONENTDATA_set)
 CTRL_CREATECUSTOMPAGE = property(_cmsdk3.PsyAPI_CTRL_CREATECUSTOMPAGE_get, _cmsdk3.PsyAPI_CTRL_CREATECUSTOMPAGE_set)
 CTRL_ADDSUBSCRIPTION = property(_cmsdk3.PsyAPI_CTRL_ADDSUBSCRIPTION_get, _cmsdk3.PsyAPI_CTRL_ADDSUBSCRIPTION_set)
 CTRL_RETRIEVESYSTEMIDS = property(_cmsdk3.PsyAPI_CTRL_RETRIEVESYSTEMIDS_get, _cmsdk3.PsyAPI_CTRL_RETRIEVESYSTEMIDS_set)
 CTRL_INTERSYSTEM_QUERY = property(_cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_get, _cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_set)
 CTRL_INTERSYSTEM_QUERY_REPLY = property(_cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_REPLY_get, _cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_REPLY_set)

Detailed Description

Definition at line 3192 of file cmsdk3.py.

Constructor & Destructor Documentation

◆ __init__()

cmsdk3.PsyAPI.__init__ ( self,
space )

Definition at line 3213 of file cmsdk3.py.

Member Function Documentation

◆ addPsyProbeCustomView()

cmsdk3.PsyAPI.addPsyProbeCustomView ( self,
name,
templateURL )

Definition at line 3309 of file cmsdk3.py.

◆ addSubscription()

cmsdk3.PsyAPI.addSubscription ( self,
xml )

Definition at line 3306 of file cmsdk3.py.

◆ contextToText()

cmsdk3.PsyAPI.contextToText ( self,
context )

Definition at line 3252 of file cmsdk3.py.

◆ createParameter()

cmsdk3.PsyAPI.createParameter ( self,
* args )

Definition at line 3330 of file cmsdk3.py.

◆ deleteParameter()

cmsdk3.PsyAPI.deleteParameter ( self,
name )

Definition at line 3336 of file cmsdk3.py.

◆ deletePrivateData()

cmsdk3.PsyAPI.deletePrivateData ( self,
name )

Definition at line 3327 of file cmsdk3.py.

◆ emitSignal()

cmsdk3.PsyAPI.emitSignal ( self,
name,
msg = None )

Definition at line 3297 of file cmsdk3.py.

◆ fromPython()

cmsdk3.PsyAPI.fromPython ( ptr)
static

Definition at line 3218 of file cmsdk3.py.

◆ fromPythonAddressOf()

cmsdk3.PsyAPI.fromPythonAddressOf ( ptr)
static

Definition at line 3222 of file cmsdk3.py.

◆ getCommandlineBasedir()

cmsdk3.PsyAPI.getCommandlineBasedir ( self)

Definition at line 3234 of file cmsdk3.py.

◆ getCurrentMessageReceiveTime()

cmsdk3.PsyAPI.getCurrentMessageReceiveTime ( self)

Definition at line 3291 of file cmsdk3.py.

◆ getCurrentPostNames()

cmsdk3.PsyAPI.getCurrentPostNames ( self)

Definition at line 3264 of file cmsdk3.py.

◆ getCurrentScript()

cmsdk3.PsyAPI.getCurrentScript ( self,
* args )

Definition at line 3258 of file cmsdk3.py.

◆ getCurrentScriptFilename()

cmsdk3.PsyAPI.getCurrentScriptFilename ( self,
* args )

Definition at line 3261 of file cmsdk3.py.

◆ getCurrentScriptLanguage()

cmsdk3.PsyAPI.getCurrentScriptLanguage ( self,
* args )

Definition at line 3255 of file cmsdk3.py.

◆ getCurrentTriggerContext()

cmsdk3.PsyAPI.getCurrentTriggerContext ( self)

Definition at line 3285 of file cmsdk3.py.

◆ getCurrentTriggerName()

cmsdk3.PsyAPI.getCurrentTriggerName ( self)

Definition at line 3282 of file cmsdk3.py.

◆ getInputQueueSize()

cmsdk3.PsyAPI.getInputQueueSize ( self)

Definition at line 3246 of file cmsdk3.py.

◆ getModuleName()

cmsdk3.PsyAPI.getModuleName ( self,
* args )

Definition at line 3240 of file cmsdk3.py.

◆ getOtherModuleName()

cmsdk3.PsyAPI.getOtherModuleName ( self,
id )

Definition at line 3243 of file cmsdk3.py.

◆ getParameter()

cmsdk3.PsyAPI.getParameter ( self,
* args )

Definition at line 3357 of file cmsdk3.py.

◆ getParameterAsBool()

cmsdk3.PsyAPI.getParameterAsBool ( self,
name )

Definition at line 3348 of file cmsdk3.py.

◆ getParameterDataType()

cmsdk3.PsyAPI.getParameterDataType ( self,
name )

Definition at line 3339 of file cmsdk3.py.

◆ getParameterFloat()

cmsdk3.PsyAPI.getParameterFloat ( self,
name )

Definition at line 3354 of file cmsdk3.py.

◆ getParameterInt()

cmsdk3.PsyAPI.getParameterInt ( self,
name )

Definition at line 3351 of file cmsdk3.py.

◆ getParameterString()

cmsdk3.PsyAPI.getParameterString ( self,
name )

Definition at line 3345 of file cmsdk3.py.

◆ getParameterValueSize()

cmsdk3.PsyAPI.getParameterValueSize ( self,
name )

Definition at line 3342 of file cmsdk3.py.

◆ getPrivateData()

cmsdk3.PsyAPI.getPrivateData ( self,
name,
data,
maxSize )

Definition at line 3324 of file cmsdk3.py.

◆ getPrivateDataCopy()

cmsdk3.PsyAPI.getPrivateDataCopy ( self,
name,
size )

Definition at line 3321 of file cmsdk3.py.

◆ getPrivateDataSize()

cmsdk3.PsyAPI.getPrivateDataSize ( self,
name )

Definition at line 3318 of file cmsdk3.py.

◆ hasCurrentPostName()

cmsdk3.PsyAPI.hasCurrentPostName ( self,
name )

Definition at line 3276 of file cmsdk3.py.

◆ hasCurrentQueryName()

cmsdk3.PsyAPI.hasCurrentQueryName ( self,
name )

Definition at line 3270 of file cmsdk3.py.

◆ hasCurrentRetrieveName()

cmsdk3.PsyAPI.hasCurrentRetrieveName ( self,
name )

Definition at line 3273 of file cmsdk3.py.

◆ hasCurrentSignalName()

cmsdk3.PsyAPI.hasCurrentSignalName ( self,
name )

Definition at line 3267 of file cmsdk3.py.

◆ hasParameter()

cmsdk3.PsyAPI.hasParameter ( self,
name )

Definition at line 3333 of file cmsdk3.py.

◆ isRunning()

cmsdk3.PsyAPI.isRunning ( self)

Definition at line 3228 of file cmsdk3.py.

◆ logPrint()

cmsdk3.PsyAPI.logPrint ( self,
level,
formatstring )

Definition at line 3393 of file cmsdk3.py.

◆ postOutputMessage()

cmsdk3.PsyAPI.postOutputMessage ( self,
* args )

Definition at line 3294 of file cmsdk3.py.

◆ queryCatalog()

cmsdk3.PsyAPI.queryCatalog ( self,
* args )

Definition at line 3384 of file cmsdk3.py.

◆ queryRemoteCatalog()

cmsdk3.PsyAPI.queryRemoteCatalog ( self,
* args )

Definition at line 3387 of file cmsdk3.py.

◆ queryReply()

cmsdk3.PsyAPI.queryReply ( self,
* args )

Definition at line 3390 of file cmsdk3.py.

◆ removePsyProbeCustomView()

cmsdk3.PsyAPI.removePsyProbeCustomView ( self,
name )

Definition at line 3312 of file cmsdk3.py.

◆ resetParameter()

cmsdk3.PsyAPI.resetParameter ( self,
name )

Definition at line 3363 of file cmsdk3.py.

◆ retrieve()

cmsdk3.PsyAPI.retrieve ( self,
* args )

Definition at line 3381 of file cmsdk3.py.

◆ retrieveAllSystemIDs()

cmsdk3.PsyAPI.retrieveAllSystemIDs ( self)

Definition at line 3303 of file cmsdk3.py.

◆ retrieveFloatParam()

cmsdk3.PsyAPI.retrieveFloatParam ( self,
result,
name,
startFloat,
endFloat = 0.123456789123456789,
maxcount = 0,
maxage = 0,
timeout = 5000 )

Definition at line 3378 of file cmsdk3.py.

◆ retrieveIntegerParam()

cmsdk3.PsyAPI.retrieveIntegerParam ( self,
* args )

Definition at line 3375 of file cmsdk3.py.

◆ retrieveStringParam()

cmsdk3.PsyAPI.retrieveStringParam ( self,
result,
name,
startString,
endString = None,
maxcount = 0,
maxage = 0,
timeout = 5000 )

Definition at line 3372 of file cmsdk3.py.

◆ retrieveTimeParam()

cmsdk3.PsyAPI.retrieveTimeParam ( self,
result,
name,
startTime,
endTime = 0,
maxcount = 0,
maxage = 0,
timeout = 5000 )

Definition at line 3369 of file cmsdk3.py.

◆ setAutoDelete()

cmsdk3.PsyAPI.setAutoDelete ( self,
autodel )

Definition at line 3225 of file cmsdk3.py.

◆ setCommandlineBasedir()

cmsdk3.PsyAPI.setCommandlineBasedir ( self,
cmdlineBasedir )

Definition at line 3237 of file cmsdk3.py.

◆ setParameter()

cmsdk3.PsyAPI.setParameter ( self,
* args )

Definition at line 3360 of file cmsdk3.py.

◆ setPrivateData()

cmsdk3.PsyAPI.setPrivateData ( self,
name,
data,
size,
mimetype = None )

Definition at line 3315 of file cmsdk3.py.

◆ shouldContinue()

cmsdk3.PsyAPI.shouldContinue ( self)

Definition at line 3231 of file cmsdk3.py.

◆ tweakParameter()

cmsdk3.PsyAPI.tweakParameter ( self,
name,
tweak )

Definition at line 3366 of file cmsdk3.py.

◆ typeToText()

cmsdk3.PsyAPI.typeToText ( self,
type )

Definition at line 3249 of file cmsdk3.py.

◆ waitForNewMessage()

cmsdk3.PsyAPI.waitForNewMessage ( self,
* args )

Definition at line 3288 of file cmsdk3.py.

◆ waitForNewMessageGroup()

cmsdk3.PsyAPI.waitForNewMessageGroup ( self,
ms,
groupName )

Definition at line 3279 of file cmsdk3.py.

◆ waitForSignal()

cmsdk3.PsyAPI.waitForSignal ( self,
name,
timeout,
lastReceivedTime = 0 )

Definition at line 3300 of file cmsdk3.py.

Property Documentation

◆ CTRL_ADDSUBSCRIPTION

cmsdk3.PsyAPI.CTRL_ADDSUBSCRIPTION = property(_cmsdk3.PsyAPI_CTRL_ADDSUBSCRIPTION_get, _cmsdk3.PsyAPI_CTRL_ADDSUBSCRIPTION_set)
static

Definition at line 3208 of file cmsdk3.py.

◆ CTRL_CONTEXT_CHANGE

cmsdk3.PsyAPI.CTRL_CONTEXT_CHANGE = property(_cmsdk3.PsyAPI_CTRL_CONTEXT_CHANGE_get, _cmsdk3.PsyAPI_CTRL_CONTEXT_CHANGE_set)
static

Definition at line 3199 of file cmsdk3.py.

◆ CTRL_CREATECUSTOMPAGE

cmsdk3.PsyAPI.CTRL_CREATECUSTOMPAGE = property(_cmsdk3.PsyAPI_CTRL_CREATECUSTOMPAGE_get, _cmsdk3.PsyAPI_CTRL_CREATECUSTOMPAGE_set)
static

Definition at line 3207 of file cmsdk3.py.

◆ CTRL_INTERSYSTEM_QUERY

cmsdk3.PsyAPI.CTRL_INTERSYSTEM_QUERY = property(_cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_get, _cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_set)
static

Definition at line 3210 of file cmsdk3.py.

◆ CTRL_INTERSYSTEM_QUERY_REPLY

cmsdk3.PsyAPI.CTRL_INTERSYSTEM_QUERY_REPLY = property(_cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_REPLY_get, _cmsdk3.PsyAPI_CTRL_INTERSYSTEM_QUERY_REPLY_set)
static

Definition at line 3211 of file cmsdk3.py.

◆ CTRL_PROCESS_GREETING

cmsdk3.PsyAPI.CTRL_PROCESS_GREETING = property(_cmsdk3.PsyAPI_CTRL_PROCESS_GREETING_get, _cmsdk3.PsyAPI_CTRL_PROCESS_GREETING_set)
static

Definition at line 3197 of file cmsdk3.py.

◆ CTRL_PROCESS_INITIALISE

cmsdk3.PsyAPI.CTRL_PROCESS_INITIALISE = property(_cmsdk3.PsyAPI_CTRL_PROCESS_INITIALISE_get, _cmsdk3.PsyAPI_CTRL_PROCESS_INITIALISE_set)
static

Definition at line 3196 of file cmsdk3.py.

◆ CTRL_PROCESS_SHUTDOWN

cmsdk3.PsyAPI.CTRL_PROCESS_SHUTDOWN = property(_cmsdk3.PsyAPI_CTRL_PROCESS_SHUTDOWN_get, _cmsdk3.PsyAPI_CTRL_PROCESS_SHUTDOWN_set)
static

Definition at line 3198 of file cmsdk3.py.

◆ CTRL_PULLCOMPONENTDATA

cmsdk3.PsyAPI.CTRL_PULLCOMPONENTDATA = property(_cmsdk3.PsyAPI_CTRL_PULLCOMPONENTDATA_get, _cmsdk3.PsyAPI_CTRL_PULLCOMPONENTDATA_set)
static

Definition at line 3206 of file cmsdk3.py.

◆ CTRL_QUERY

cmsdk3.PsyAPI.CTRL_QUERY = property(_cmsdk3.PsyAPI_CTRL_QUERY_get, _cmsdk3.PsyAPI_CTRL_QUERY_set)
static

Definition at line 3204 of file cmsdk3.py.

◆ CTRL_QUERY_REPLY

cmsdk3.PsyAPI.CTRL_QUERY_REPLY = property(_cmsdk3.PsyAPI_CTRL_QUERY_REPLY_get, _cmsdk3.PsyAPI_CTRL_QUERY_REPLY_set)
static

Definition at line 3205 of file cmsdk3.py.

◆ CTRL_RETRIEVESYSTEMIDS

cmsdk3.PsyAPI.CTRL_RETRIEVESYSTEMIDS = property(_cmsdk3.PsyAPI_CTRL_RETRIEVESYSTEMIDS_get, _cmsdk3.PsyAPI_CTRL_RETRIEVESYSTEMIDS_set)
static

Definition at line 3209 of file cmsdk3.py.

◆ CTRL_SYSTEM_READY

cmsdk3.PsyAPI.CTRL_SYSTEM_READY = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_READY_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_READY_set)
static

Definition at line 3195 of file cmsdk3.py.

◆ CTRL_SYSTEM_SHUTDOWN

cmsdk3.PsyAPI.CTRL_SYSTEM_SHUTDOWN = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTDOWN_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTDOWN_set)
static

Definition at line 3200 of file cmsdk3.py.

◆ CTRL_SYSTEM_SHUTTINGDOWN

cmsdk3.PsyAPI.CTRL_SYSTEM_SHUTTINGDOWN = property(_cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTTINGDOWN_get, _cmsdk3.PsyAPI_CTRL_SYSTEM_SHUTTINGDOWN_set)
static

Definition at line 3201 of file cmsdk3.py.

◆ CTRL_TRIGGER

cmsdk3.PsyAPI.CTRL_TRIGGER = property(_cmsdk3.PsyAPI_CTRL_TRIGGER_get, _cmsdk3.PsyAPI_CTRL_TRIGGER_set)
static

Definition at line 3202 of file cmsdk3.py.

◆ CTRL_TRIGGER_GROUP

cmsdk3.PsyAPI.CTRL_TRIGGER_GROUP = property(_cmsdk3.PsyAPI_CTRL_TRIGGER_GROUP_get, _cmsdk3.PsyAPI_CTRL_TRIGGER_GROUP_set)
static

Definition at line 3203 of file cmsdk3.py.

◆ thisown

cmsdk3.PsyAPI.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 3193 of file cmsdk3.py.


The documentation for this class was generated from the following file:
  • /home/ubuntu/c/partner/psyclone2/CMSDK/src/cmsdk3.py