/AWS1/CL_RBMTOOL

Information about a tool. Tools are used in a simulation job.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/RBMNAME /AWS1/RBMNAME

The name of the tool.

iv_command TYPE /AWS1/RBMUNRESTRICTEDCOMMAND /AWS1/RBMUNRESTRICTEDCOMMAND

Command-line arguments for the tool. It must include the tool executable name.

Optional arguments:

iv_streamui TYPE /AWS1/RBMBOXEDBOOLEAN /AWS1/RBMBOXEDBOOLEAN

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

iv_streamoutputtocloudwatch TYPE /AWS1/RBMBOXEDBOOLEAN /AWS1/RBMBOXEDBOOLEAN

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

iv_exitbehavior TYPE /AWS1/RBMEXITBEHAVIOR /AWS1/RBMEXITBEHAVIOR

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

---

Queryable Attributes

streamUI

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Accessible with the following methods

Method	Description
GET_STREAMUI()	Getter for STREAMUI, with configurable default
ASK_STREAMUI()	Getter for STREAMUI w/ exceptions if field has no value
HAS_STREAMUI()	Determine if STREAMUI has a value

name

The name of the tool.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

command

Command-line arguments for the tool. It must include the tool executable name.

Accessible with the following methods

Method	Description
GET_COMMAND()	Getter for COMMAND, with configurable default
ASK_COMMAND()	Getter for COMMAND w/ exceptions if field has no value
HAS_COMMAND()	Determine if COMMAND has a value

streamOutputToCloudWatch

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

Accessible with the following methods

Method	Description
GET_STREAMOUTPUTTOCLOUDWATCH()	Getter for STREAMOUTPUTTOCLOUDWATCH, with configurable defau
ASK_STREAMOUTPUTTOCLOUDWATCH()	Getter for STREAMOUTPUTTOCLOUDWATCH w/ exceptions if field h
HAS_STREAMOUTPUTTOCLOUDWATCH()	Determine if STREAMOUTPUTTOCLOUDWATCH has a value

exitBehavior

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Accessible with the following methods

Method	Description
GET_EXITBEHAVIOR()	Getter for EXITBEHAVIOR, with configurable default
ASK_EXITBEHAVIOR()	Getter for EXITBEHAVIOR w/ exceptions if field has no value
HAS_EXITBEHAVIOR()	Determine if EXITBEHAVIOR has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_TOOLS

TYPES TT_TOOLS TYPE STANDARD TABLE OF REF TO /AWS1/CL_RBMTOOL WITH DEFAULT KEY
.