#include <mujincontrollerclient.h>

mujinclient::TaskResourceに対する継承グラフ

mujinclient::TaskResourceのコラボレーション図

Public メソッド
	TaskResource (ControllerClientPtr controller, const std::string &pk)
virtual	~TaskResource ()
virtual bool	Execute ()
	execute the task.
virtual void	Cancel ()
	if the task is currently executing, send a cancel request
virtual void	GetRunTimeStatus (JobStatus &status, int options=1)
	get the run-time status of the executed task.
virtual OptimizationResourcePtr	GetOrCreateOptimizationFromName_UTF8 (const std::string &optimizationname, const std::string &optimizationtype=std::string("robotplacement"))
	Gets or creates the a optimization part of the scene.
virtual OptimizationResourcePtr	GetOrCreateOptimizationFromName_UTF16 (const std::wstring &optimizationname, const std::string &optimizationtype=std::string("robotplacement"))
virtual void	GetOptimizationPrimaryKeys (std::vector< std::string > &optimizationkeys)
	gets a list of all the scene primary keys currently available to the user
virtual void	GetTaskParameters (ITLPlanningTaskParameters &taskparameters)
	Get the task info for tasks of type itlplanning
virtual void	SetTaskParameters (const ITLPlanningTaskParameters &taskparameters)
	Set new task info for tasks of type itlplanning
virtual PlanningResultResourcePtr	GetResult ()
	gets the result of the task execution. If no result has been computed yet, will return a NULL pointer.
Public メソッド inherited from mujinclient::WebResource
	WebResource (ControllerClientPtr controller, const std::string &resourcename, const std::string &pk)
virtual	~WebResource ()
ControllerClientPtr	GetController () const
const std::string &	GetResourceName () const
const std::string &	GetPrimaryKey () const
virtual std::string	Get (const std::string &field)
	gets an attribute of this web resource
virtual void	Set (const std::string &field, const std::string &newvalue)
	sets an attribute of this web resource
virtual void	Delete ()
	delete the resource and all its child resources
virtual void	Copy (const std::string &newname, int options)
	copy the resource and all its child resources to a new name

Protected 変数
std::string	_jobpk
	the job primary key used to track the status of the running task after Execute is called

説明

例:: mujinshowresults.cpp.

mujincontrollerclient.h の 891 行で定義されています。

コンストラクタとデストラクタ

mujinclient::TaskResource::TaskResource	(	ControllerClientPtr	controller,
		const std::string &	pk
	)

virtual mujinclient::TaskResource::~TaskResource ( )

inlinevirtual

mujincontrollerclient.h の 895 行で定義されています。

関数

virtual void mujinclient::TaskResource::Cancel ( )

virtual

if the task is currently executing, send a cancel request

virtual bool mujinclient::TaskResource::Execute ( )

virtual

execute the task.

This operation is non-blocking and will return immediately after the execution is started. In order to check if the task is running or is complete, use GetRunTimeStatus() and GetResult()

戻り値: true if task was executed fine

virtual void mujinclient::TaskResource::GetOptimizationPrimaryKeys ( std::vector< std::string > & optimizationkeys )

virtual

gets a list of all the scene primary keys currently available to the user

virtual OptimizationResourcePtr mujinclient::TaskResource::GetOrCreateOptimizationFromName_UTF16	(	const std::wstring &	optimizationname,
		const std::string &	optimizationtype = `std::string("robotplacement")`
	)

virtual

参照: GetOrCreateOptimizationFromName_UTF8

virtual OptimizationResourcePtr mujinclient::TaskResource::GetOrCreateOptimizationFromName_UTF8	(	const std::string &	optimizationname,
		const std::string &	optimizationtype = `std::string("robotplacement")`
	)

virtual

Gets or creates the a optimization part of the scene.

引数

optimizationname	the name of the optimization to search for or create
optimizaitontype	The type of optimization, can be "robotplacement" or "placements"

virtual PlanningResultResourcePtr mujinclient::TaskResource::GetResult ( )

virtual

gets the result of the task execution. If no result has been computed yet, will return a NULL pointer.

mujinclient::BinPickingTaskResource, と mujinclient::HandEyeCalibrationTaskResourceで再定義されています。

virtual void mujinclient::TaskResource::GetRunTimeStatus	(	JobStatus &	status,
		int	options = `1`
	)

virtual

get the run-time status of the executed task.

This will only work if the task has been previously Executed with execute If the task is not currently running, will set status.code to JSC_Unknown

引数

options if options is 1, also get the message

virtual void mujinclient::TaskResource::GetTaskParameters ( ITLPlanningTaskParameters & taskparameters )

virtual

Get the task info for tasks of type itlplanning

virtual void mujinclient::TaskResource::SetTaskParameters ( const ITLPlanningTaskParameters & taskparameters )

virtual

Set new task info for tasks of type itlplanning

変数

std::string mujinclient::TaskResource::_jobpk

protected

the job primary key used to track the status of the running task after Execute is called

mujincontrollerclient.h の 936 行で定義されています。

このクラスの説明は次のファイルから生成されました:

/home/mujin/mujin/checkoutroot/controllerclientcpp/include/mujincontrollerclient/mujincontrollerclient.h (2016-07-21 19:43:21 +0900, commit:f216abb)

Public メソッド

Protected 変数

説明

コンストラクタとデストラクタ

関数

変数