CoppeliaSim 4.3.0 User Manual - CoppeliaSim 4.3.0 使用者手冊

  • Home
    • Site Map
    • reveal
    • blog
  • welcome
  • userInterface
    • pagesAndViews
    • coordinateDialog
    • positionDialog
    • orientationDialog
    • objectMovement
    • positionOrientationTransformation
    • settings
    • shortcuts
  • scenesAndModels
    • scenes
    • models
    • modelDialog
  • environment
    • environmentPropertiesDialog
    • textureDialog
  • entities
    • collections
    • objects
      • sceneObjectPropertiesDialog
      • commonPropertiesDialog
    • collidableObjects
    • measurableObjects
    • detectableObjects
    • viewableObjects
    • convexHull
    • layerSelectionDialog
      • cameras
      • cameraPropertiesDialog
      • lights
      • lightPropertiesDialog
      • shapes
      • shapeReferenceFrames
      • primitiveShapes
      • convexDecomposition
      • shapeProperties
      • shapeDynamicsProperties
      • shapeDynamicEngineProperties
      • geometryDialog
      • shapeEditModes
      • triangleEditMode
      • vertexEditMode
      • edgeEditMode
      • groupedShapeEditMode
      • joints
      • jointModes
      • jointProperties
      • jointDynamicsProperties
      • jointDynamicEngineProperties
      • dummies
      • dummyPropertiesDialog
      • graphs
      • graphPropertiesDialog
      • proximitySensors
      • proximitySensorDescription
      • proximitySensorPropertiesDialog
      • proximitySensorVolumeDialog
      • proximitySensorDetectionParameterDialog
      • visionSensors
      • visionSensorDescription
      • visionSensorPropertiesDialog
      • forceSensors
      • forceSensorPropertiesDialog
      • octrees
      • octreePropertiesDialog
      • pointClouds
      • pointCloudPropertiesDialog
    • paths
  • functionality
    • geometricCalculations
    • collisionDetection
    • distanceCalculation
      • geometricPlugin
      • simGeom API
      • coppeliaGeometricRoutines
      • CoppeliaGeometricRoutinesAPI
    • IGLPluginAPIreference
    • kinematics
    • basicsOnIkGroupsAndIkElements
    • solvingIkAndFk
      • kinematicsPlugin
      • simIKAPI
      • coppeliaKinematicsRoutines
      • CoppeliaKinematicsRoutinesAPI
    • dynamicsModule
    • designingDynamicSimulations
      • dynamicsDialog
      • dynamicsEngineDialog
    • dataVisualizationAndOutput
    • externalFrontEnd
    • dataTransformation
    • meansOfCommunication
      • remoteApiOverview
      • zmqRemoteApiOverview
      • wsRemoteApiOverview
      • rosInterfaces
      • rosInterf
      • ROSPluginAPIreference
      • ros2Interface
      • ROS2PluginAPIreference
    • ZMQPluginAPIreference
    • WSPluginAPIreference
    • pathsAndTrajectories
    • pathAndMotionPlanningModules
    • OMPLPluginAPIreference
    • syntheticVision
    • IMPluginAPIreference
    • simVisionAPI
    • customUIPlugin
    • UIPluginAPIreference
    • simUI-widgets
    • QMLPluginAPIreference
    • importExport
    • xmlFormat
      • urdfPlugin
      • APIFunctions
      • sdfPlugin
      • SDFPluginAPIreference
    • aviRecorder
    • AssimpPluginAPIreference
    • GLTFPluginAPIreference
      • commandLine
      • LuaCmdPluginAPIreference
      • miscellaneousFunctionality
      • SurfRecPluginAPIreference
      • ICPPluginAPIreference
      • SubprocessPluginAPIreference
  • writingCode
    • scripts
      • embeddedScripts
      • simulationScripts
      • mainScript
      • childScripts
      • customizationScripts
      • scriptProperties
      • scriptEditor
    • addOns
    • sandboxScript
    • scriptExecution
    • threadedAndNonThreadedCode
      • callbackFunctions
      • dynCallbackFunctions
      • jointCallbackFunctions
      • contactCallbackFunction
      • visionCallbackFunctions
      • triggerCallbackFunctions
      • userConfigCallbackFunctions
    • luaPythonDifferences
    • luaCrashCourse
    • plugins
    • mainClientApplication
    • accessingSceneObjects
    • explicitHandling
    • apisOverview
      • apiFunctions
      • apiConstants
      • objectParameterIDs
  • simulation
    • simulationPropertiesDialog
  • tutorials
    • bubbleRobTutorial
    • buildingAModelTutorial
    • lineFollowingBubbleRobTutorial
    • inverseKinematicsTutorial
    • externalControllerTutorial
    • pluginTutorial
    • robotLanguageIntegrationTutorial
    • rosTutorial
      • ros1Tutorial
      • ros2Tutorial
    • compilingCoppeliaSim
ICPPluginAPIreference << Previous Next >> writingCode

SubprocessPluginAPIreference

Subprocess Plugin API reference

API functions for subprocess

simSubprocess.exec
simSubprocess.execAsync
simSubprocess.isRunning
simSubprocess.kill
simSubprocess.wait

simSubprocess.exec
Description Execute a subprocess.
Lua synopsis int exitCode, string output=simSubprocess.exec(string programPath, string[] args, string input="", exec_opts opts={})
Lua parameters
programPath (string): Program path.
args (table of string): Program arguments.
input (string, default: ""): Data passed to stdin.
opts (exec_opts, default: {}): Options. see exec_opts
Lua return values
exitCode (int):
output (string):
Python synopsis int exitCode, string output=simSubprocess.exec(string programPath, list args, string input="", exec_opts opts={})
See also


simSubprocess.execAsync
Description Execute a subprocess without waiting for termination.
Lua synopsis string handle=simSubprocess.execAsync(string programPath, string[] args, exec_opts opts={})
Lua parameters
programPath (string): Program path.
args (table of string): Program arguments.
opts (exec_opts, default: {}): Options. see exec_opts
Lua return values
handle (string):
Python synopsis string handle=simSubprocess.execAsync(string programPath, list args, exec_opts opts={})
See also


simSubprocess.isRunning
Description Check wether a subprocess previously launched with simSubprocess.execAsync is running.
Lua synopsis bool running=simSubprocess.isRunning(string handle)
Lua parameters
handle (string):
Lua return values
running (bool):
Python synopsis bool running=simSubprocess.isRunning(string handle)
See also


simSubprocess.kill
Description Forcefully terminate a subprocess previously launched with simSubprocess.execAsync.
Lua synopsis int exitCode=simSubprocess.kill(string handle)
Lua parameters
handle (string):
Lua return values
exitCode (int):
Python synopsis int exitCode=simSubprocess.kill(string handle)
See also


simSubprocess.wait
Description Wait for termination of a subprocess previously launched with simSubprocess.execAsync. If subprocess terminates, the exit code is returned.
Lua synopsis int exitCode=simSubprocess.wait(string handle, float timeout=5)
Lua parameters
handle (string):
timeout (float, default: 5):
Lua return values
exitCode (int):
Python synopsis int exitCode=simSubprocess.wait(string handle, float timeout=5)
See also



Data structures

Data structures are used to pass complex data around. Create data structures in Lua in the form of a map, e.g.: {line_size=3, add_to_legend=false, selectable=true}


exec_opts
Description
Fields
useSearchPath (bool, default: true): Resolve program name searching in PATH entries.
openNewConsole (bool, default: false): Win32-specific flag.
See also

, , , ,
ICPPluginAPIreference << Previous Next >> writingCode

Copyright © All rights reserved | This template is made with by Colorlib