C-API | OP_COMMAND

Use this enumeration to specify the type of command to be issued to the target object with attributea you want to use on a given object with OpalCommand.

For each command, the requirements vary depending on the owner ID supplied to OpalCommand. All possible combinations of commands and owner ID classes are listed in the table of elements below.

typedef enum{

CMD_UNKNOWN,

CMD_NEW,

CMD_ADD,

CMD_OPEN,

CMD_SAVE,

CMD_CLOSE,

CMD_REMOVE,

CMD_REFRESH,

CMD_EXECUTE,

CMD_FIND,

CMD_PAUSE,

CMD_RESUME,

CMD_CANCEL};

• New Project:
  • Owner ID class: OP_RTLAB_OBJ
  • Command: CMD_NEW
  • Description: Create a new project in the current RTLab session. If a project is already open it is closed.
  • Required control: None
  • Required attributes: ATT_FILENAME
  • Optional attributes: None
  • Output ID class: OP_PROJECT_OBJ
• Open Project:
  
  • Owner ID class: OP_RTLAB_OBJ
  • Command: CMD_OPEN
  • Description: Open an existing project from file or connect to an active project. After this action, the project opened becomes the current project in the
    current RT-Lab session. If a project is open beforehand it is closed. When connecting to a previously active project, control of this project may also be requested.
  • Required control: None
  • Required attributes: None
  • Optional attributes: ATT_FILENAME, ATT_API_INSTANCE_ID, ATT_FUNCTIONAL_BLOCK, ATT_CONTROL_PRIOTRITY, ATT_RETURN_ON_AMBIGUUITY
  • Output ID class: OP_PROJECT_OBJ
• Add Default Environment Variable:
  • Owner ID class: OP_RTLAB_OBJ
  • Command: CMD_ADD
  • Description: Add an environment variable to the default RT-LAB settings. This variable will NOT affect the current project directly.
  • Required control: OP_FB_CONFIG
  • Required attributes: ATT_OBJECT_TYPE, ATT_NAME
  • Required attribute values: ATT_OBJECT_TYPE = OP_ENVIRONMENT_VARIABLE_OBJ
  • Optional attributes: ATT_VALUE
  • Output ID class: OP_ENVIRONMENT_VARIABLE_OBJ
• Add Target:
  • Owner ID class: OP_RTLAB_OBJ
  • Command: CMD_ADD
  • Description: Add a target that may be used by any RT-LAB project.
  • Required control: OP_FB_CONFIG
  • Required attributes: ATT_OBJECT_TYPE, ATT_NAME, ATT_IP_ADDRESS, ATT_TARGET_PLATFORM
  • Required attribute values: ATT_OBJECT_TYPE = OP_TARGET_OBJ
  • Optional attributes: None.
  • Output ID class: OP_TARGET_OBJ
• Remove Object from RT-LAB:
  • Owner ID class: OP_RTLAB_OBJ
  • Command: CMD_REMOVE
  • Description: Removes an object from the default RTLAB settings.
  • Required control: OP_FB_CONFIG
  • Required attributes: ATT_REF_ID
  • Optional attributes: None.
  • Output ID class: Same as the value of ATT_REF_ID
• Add Model:
  • Owner ID class: OP_PROJECT_OBJ
  • Command: CMD_ADD
  • Description: Add a model to the current project.
  • Required control: OP_FB_SYSTEM
  • Required attributes: ATT_FILENAME
  • Optional attributes: None
  • Output ID class: OP_MODEL_OBJ
• Save Project:
  • Command: CMD_SAVE
  • Description: Save the existing project’s settings to a file.
  • Owner type: OP_TYPE_PROJECT
  • Required control: OP_FB_SYSTEM
  • Required attributes: None
  • Optional attributes: ATT_FILENAME
  • Output ID class: OP_PROJECT_OBJ
• Close Project:
  • Command: CMD_CLOSE
  • Description: Close the currently open project.
  • Owner type: OP_TYPE_PROJECT
  • Required control: None
  • Required attributes: None
  • Optional attributes: None
  • Output ID class: OP_PROJECT_OBJ
• Remove Model:
  • Command: CMD_REMOVE
  • Description: Remove a model from the current project.
  • Owner type: OP_TYPE_PROJECT
  • Required control: OP_FB_SYSTEM
  • Required attributes: ATT_REF_ID
  • Optional attributes: None
  • Output ID class: OP_MODEL_OBJ
• Add EnvironmentVariable:
  • Owner ID class: OP_MODEL_OBJ
  • Command: CMD_ADD
  • Description: Add an environment variable a model.
  • Required control: OP_FB_SYSTEM
  • Required attributes: ATT_OBJECT_TYPE, ATT_NAME
  • Required attribute values: ATT_OBJECT_TYPE = OP_ENVIRONMENT_VARIABLE_OBJ
  • Optional attributes: ATT_VALUE
  • Output ID class: OP_ENVIRONMENT_VARIABLE_OBJ
• Load Model Configuration:
  • Name: CMD_OPEN
  • Description: Load an existing model’s settings from a file.
  • Owner type: OP_TYPE_MODEL
  • Required control: OP_FB_SYSTEM
  • Required attributes: ATT_FILENAME
  • Optional attributes: None
  • Output ID class: Same as the value of ATT_REF_ID
• Save Model
  • Name: CMD_SAVE
  • Description: Save an existing model’s settings to a file.
  • Owner type: OP_TYPE_MODEL
  • Required control: OP_FB_SYSTEM
  • Required attributes: None
  • Optional attributes: ATT_FILENAME
  • Output ID class: Same as the value of ATT_REF_ID
• Remove Object from Model
  • Owner ID class: OP_MODEL_OBJ
  • Command: CMD_REMOVE
  • Description: Removes an object from a model.
  • Required control: OP_FB_SYSTEM
  • Required attributes: ATT_REF_ID
  • Optional attributes: None.
  • Output ID class: Same as the value of ATT_REF_ID
• Add to Selection:
  • Owner ID class: OP_SLECTION_OBJ
  • Command: CMD_ADD
  • Description: Add an object to a selection.
  • Required control: None
  • Required attributes: ATT_REF_ID
  • Optional attributes: None
  • Output ID class: Same as the value of ATT_REF_ID
• Remove from Selection:
  • Owner ID class: OP_SLECTION_OBJ
  • Command: CMD_REMOVE
  • Description: Removes an object from a selection.
  • Required control: None.
  • Required attributes: ATT_REF_ID
  • Optional attributes: None.
  • Output ID class: Same as the value of ATT_REF_ID