Class: Invocation

Invocation(invocation_obj)

An invocation

Constructor

new Invocation(invocation_obj)

constructor
Parameters:
Name Type Description
invocation_obj Object invocation object
Source:

Methods

pushDocs(dbName, doc_documents)

Push ASFM documents
Parameters:
Name Type Description
dbName string database name
doc_documents Array.<Object> ASFM documents
Source:

pushLogs(dbName, artefactIds)

Push ASFM documents
Parameters:
Name Type Description
dbName string database name
artefactIds Array.<string> Log artefact IDs
Source:

pushRawDocs(dbName, doc_files)

Push documentation files as invocation results
Parameters:
Name Type Description
dbName string database name
doc_files Array.<File> documentation files
Source:

pushRawSourceCodes(dbName, source_code_files)

Push source code files as invocation results
Parameters:
Name Type Description
dbName string database name
source_code_files Array.<File> source code files
Source:

pushResult(path, type)

Push an invocation result
Parameters:
Name Type Description
path string path to the PKM resource (with URI encoded components)
type string type of the resource
Source:

pushSourceCodes(dbName, lang, type, source_code_documents)

Push source code artefacts as invocation results
Parameters:
Name Type Description
dbName string database name
lang string language (c, cpp, or java)
type string type (sourcecode, comments, annotations)
source_code_documents Array.<Object> source code documents (either source code AST, comments, or annotations)
Source:

setTimestampCompleted(dbName, date)

Set completion time stamp (format is YYYYMMDD_hhmmss, e.g. 20211102_172235 for November 2nd, 2021, at 17'22"35)
Parameters:
Name Type Description
dbName string database name
date Date date of completion
Source: