Module helics.flaskr¶
Classes¶
APIException¶
class APIException(self, code, message)
Common base class for all non-exit exceptions.
Initialize self. See help(type(self)) for accurate signature.
Base classes¶
builtins.Exception
Instance attributes¶
-
code
-
message
BrokerServer¶
class BrokerServer()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
def post(self)
Cores¶
class Cores()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
DataTable¶
class DataTable()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Database¶
class Database()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
def post(self)
DatabaseManager¶
class DatabaseManager(self, path_to_helics_db=cache["path"])
Initialize self. See help(type(self)) for accurate signature.
Methods¶
def instaniate(self)
Federates¶
class Federates()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Graph¶
class Graph()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Health¶
class Health()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Inputs¶
class Inputs()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Profile¶
class Profile()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
def post(self)
Publications¶
class Publications()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
RunnerFile¶
class RunnerFile()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
def post(self)
RunnerFileEdit¶
class RunnerFileEdit()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def delete(self)
def post(self)
def put(self)
RunnerFileFolder¶
class RunnerFileFolder()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def post(self)
RunnerFileName¶
class RunnerFileName()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def post(self)
RunnerFilePath¶
class RunnerFilePath()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def post(self)
RunnerKillBroker¶
class RunnerKillBroker()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def post(self)
RunnerLog¶
class RunnerLog()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self, name)
RunnerRun¶
class RunnerRun()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def delete(self)
def get(self)
def post(self)
RunnerStatus¶
class RunnerStatus()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
def post(self)
Subscriptions¶
class Subscriptions()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
SystemInfo¶
class SystemInfo()
Represents an abstract RESTful resource. Concrete resources should
extend from this class and expose methods for each supported HTTP
method. If a resource is invoked with an unsupported HTTP method,
the API will return a response with status 405 Method Not Allowed.
Otherwise the appropriate method is called and passed all arguments
from the url rule used when adding the resource to an Api instance. See
:meth:~flask_restful.Api.add_resource for details.
Base classes¶
flask_restful.Resource
Methods¶
def get(self)
Functions¶
index¶
def index(path)
run¶
def run()