SPeCS Packages Documentation
Preparing search index...
@specs-feup/extended-task-graph
api/ExtendedTaskGraphAPI
ExtendedTaskGraphAPI
Class ExtendedTaskGraphAPI
Hierarchy (
View Summary
)
AStage
ExtendedTaskGraphAPI
Index
Constructors
constructor
Methods
delete
Folder
Contents
dump
Task
Graph
gather
Task
Graph
Metrics
generate
Code
generate
File
generate
Source
Code
generate
Task
Graph
get
App
Name
get
Common
Prefix
get
Output
Dir
get
Top
Function
Join
Point
get
Top
Function
Name
get
Valid
Functions
log
log
End
log
Error
log
Line
log
Output
log
Start
log
Success
log
Trace
log
Warning
run
Code
Transformation
Flow
run
Task
Graph
Generation
Flow
save
To
File
save
To
File
In
Subfolder
set
App
Name
set
Label
Color
set
Output
Dir
Constructors
constructor
new
ExtendedTaskGraphAPI
(
topFunctionName
?:
string
,
outputDir
?:
string
,
appName
?:
string
,
)
:
ExtendedTaskGraphAPI
Parameters
topFunctionName
:
string
= "main"
outputDir
:
string
= "output"
appName
:
string
= "default_app_name"
Returns
ExtendedTaskGraphAPI
Methods
delete
Folder
Contents
deleteFolderContents
(
folder
:
string
)
:
void
Parameters
folder
:
string
Returns
void
dump
Task
Graph
dumpTaskGraph
(
etg
:
TaskGraph
,
subfolder
?:
string
)
:
void
Parameters
etg
:
TaskGraph
Optional
subfolder
:
string
Returns
void
gather
Task
Graph
Metrics
gatherTaskGraphMetrics
(
etg
:
TaskGraph
,
subfolder
?:
string
)
:
Record
<
string
,
any
>
Parameters
etg
:
TaskGraph
Optional
subfolder
:
string
Returns
Record
<
string
,
any
>
generate
Code
generateCode
(
subfolder
:
string
)
:
string
Parameters
subfolder
:
string
Returns
string
generate
File
generateFile
(
filepath
:
string
,
content
:
string
)
:
string
Parameters
filepath
:
string
content
:
string
Returns
string
generate
Source
Code
generateSourceCode
(
subfolder
:
string
)
:
void
Parameters
subfolder
:
string
Returns
void
generate
Task
Graph
generateTaskGraph
(
subfolder
?:
string
)
:
TaskGraph
|
null
Parameters
Optional
subfolder
:
string
Returns
TaskGraph
|
null
get
App
Name
getAppName
()
:
string
Returns
string
get
Common
Prefix
getCommonPrefix
()
:
string
Returns
string
get
Output
Dir
getOutputDir
()
:
string
Returns
string
get
Top
Function
Join
Point
getTopFunctionJoinPoint
()
:
FunctionJp
Returns
FunctionJp
get
Top
Function
Name
getTopFunctionName
()
:
string
Returns
string
get
Valid
Functions
getValidFunctions
()
:
FunctionJp
[]
Returns
FunctionJp
[]
Protected
log
log
(
message
:
string
)
:
void
Parameters
message
:
string
Returns
void
Protected
log
End
logEnd
()
:
void
Returns
void
Protected
log
Error
logError
(
message
:
string
)
:
void
Parameters
message
:
string
Returns
void
Protected
log
Line
logLine
(
len
?:
number
)
:
void
Parameters
len
:
number
= 58
Returns
void
Protected
log
Output
logOutput
(
message
:
string
,
path
:
string
)
:
void
Parameters
message
:
string
path
:
string
Returns
void
Protected
log
Start
logStart
()
:
void
Returns
void
Protected
log
Success
logSuccess
(
message
:
string
)
:
void
Parameters
message
:
string
Returns
void
Protected
log
Trace
logTrace
(
exception
:
unknown
)
:
string
Parameters
exception
:
unknown
Returns
string
Protected
log
Warning
logWarning
(
message
:
string
)
:
void
Parameters
message
:
string
Returns
void
run
Code
Transformation
Flow
runCodeTransformationFlow
(
config
?:
TransFlowConfig
)
:
boolean
Parameters
config
:
TransFlowConfig
= ...
Returns
boolean
run
Task
Graph
Generation
Flow
runTaskGraphGenerationFlow
(
config
?:
GenFlowConfig
)
:
TaskGraph
|
null
Parameters
config
:
GenFlowConfig
= ...
Returns
TaskGraph
|
null
Protected
save
To
File
saveToFile
(
content
:
string
,
filename
:
string
)
:
string
Parameters
content
:
string
filename
:
string
Returns
string
Protected
save
To
File
In
Subfolder
saveToFileInSubfolder
(
content
:
string
,
filename
:
string
,
subfolder
:
string
,
)
:
string
Parameters
content
:
string
filename
:
string
subfolder
:
string
Returns
string
set
App
Name
setAppName
(
appName
:
string
)
:
void
Parameters
appName
:
string
Returns
void
set
Label
Color
setLabelColor
(
color
:
(
...
text
:
unknown
[]
)
=>
string
)
:
void
Parameters
color
:
(
...
text
:
unknown
[]
)
=>
string
Returns
void
set
Output
Dir
setOutputDir
(
outputDir
:
string
)
:
void
Parameters
outputDir
:
string
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
delete
Folder
Contents
dump
Task
Graph
gather
Task
Graph
Metrics
generate
Code
generate
File
generate
Source
Code
generate
Task
Graph
get
App
Name
get
Common
Prefix
get
Output
Dir
get
Top
Function
Join
Point
get
Top
Function
Name
get
Valid
Functions
log
log
End
log
Error
log
Line
log
Output
log
Start
log
Success
log
Trace
log
Warning
run
Code
Transformation
Flow
run
Task
Graph
Generation
Flow
save
To
File
save
To
File
In
Subfolder
set
App
Name
set
Label
Color
set
Output
Dir
SPeCS Packages Documentation
Loading...