controllerclientcpp  0.6.1
 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 マクロ定義 ページ
Public メソッド | Protected 変数 | すべてのメンバ一覧
クラス mujinclient::OptimizationResource

#include <mujincontrollerclient.h>

mujinclient::OptimizationResourceに対する継承グラフ
Inheritance graph
[凡例]
mujinclient::OptimizationResourceのコラボレーション図
Collaboration graph
[凡例]

Public メソッド

 OptimizationResource (ControllerClientPtr controller, const std::string &pk)
virtual ~OptimizationResource ()
virtual void Execute (bool bClearOldResults=true)
 execute the optimization
virtual void Cancel ()
 if the optimization is currently executing, send a cancel request
void SetOptimizationParameters (const RobotPlacementOptimizationParameters &optparams)
 Set new task info for tasks of type robotplanning
void SetOptimizationParameters (const PlacementsOptimizationParameters &optparams)
 Set new task info for tasks of type placements
virtual void GetRunTimeStatus (JobStatus &status, int options=1)
 get the run-time status of the executed optimization.
virtual void GetResults (std::vector< PlanningResultResourcePtr > &results, int startoffset=0, int num=0)
 Gets the results of the optimization execution ordered by task_time.
- 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 optimization after Execute is called

説明

例:
mujinshowresults.cpp.

mujincontrollerclient.h939 行で定義されています。

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

mujinclient::OptimizationResource::OptimizationResource ( ControllerClientPtr  controller,
const std::string &  pk 
)
virtual mujinclient::OptimizationResource::~OptimizationResource ( )
inlinevirtual

mujincontrollerclient.h943 行で定義されています。

関数

virtual void mujinclient::OptimizationResource::Cancel ( )
virtual

if the optimization is currently executing, send a cancel request

virtual void mujinclient::OptimizationResource::Execute ( bool  bClearOldResults = true)
virtual

execute the optimization

引数
bClearOldResultsif true, will clear the old optimiation results. If false, will keep the old optimization results and only compute those that need to be computed.
virtual void mujinclient::OptimizationResource::GetResults ( std::vector< PlanningResultResourcePtr > &  results,
int  startoffset = 0,
int  num = 0 
)
virtual

Gets the results of the optimization execution ordered by task_time.

引数
startoffsetThe offset to retrieve the results from. Ordered
numThe number of results to get starting at startoffset. If 0, will return ALL results.
virtual void mujinclient::OptimizationResource::GetRunTimeStatus ( JobStatus status,
int  options = 1 
)
virtual

get the run-time status of the executed optimization.

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

引数
optionsif options is 1, also get the message
void mujinclient::OptimizationResource::SetOptimizationParameters ( const RobotPlacementOptimizationParameters optparams)

Set new task info for tasks of type robotplanning

void mujinclient::OptimizationResource::SetOptimizationParameters ( const PlacementsOptimizationParameters optparams)

Set new task info for tasks of type placements

変数

std::string mujinclient::OptimizationResource::_jobpk
protected

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

mujincontrollerclient.h974 行で定義されています。


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