Creates on MUJIN Controller instance. [詳細]

#include <mujincontrollerclient.h>

Public メソッド
virtual	~ControllerClient ()
virtual void	SetCharacterEncoding (const std::string &newencoding)=0
	sets the character encoding for all strings that are being input and output from the resources
virtual void	SetLanguage (const std::string &language)=0
	sets the language code for all output
virtual const std::string &	GetUserName () const =0
	returns the username logged into this controller
virtual void	SetProxy (const std::string &serverport, const std::string &userpw)=0
	If necessary, changes the proxy to communicate to the controller server.
virtual void	RestartServer ()=0
	Restarts the MUJIN Controller Server and destroys any optimizaiton jobs.
virtual void	Upgrade (const std::vector< unsigned char > &vdata)=0
	Upgrade the controller with this data.
virtual std::string	GetVersion ()=0
	returns the mujin controller version
virtual void	CancelAllJobs ()=0
	sends the cancel message to all jobs.
virtual void	GetRunTimeStatuses (std::vector< JobStatus > &statuses, int options=0)=0
	get all the run-time statuses
virtual void	GetScenePrimaryKeys (std::vector< std::string > &scenekeys)=0
	gets a list of all the scene primary keys currently available to the user
virtual SceneResourcePtr	RegisterScene_UTF8 (const std::string &uri, const std::string &scenetype)=0
	Register a scene to be used by the MUJIN Controller.
virtual SceneResourcePtr	RegisterScene_UTF8 (const std::string &uri)
	registers scene with default scene type
virtual SceneResourcePtr	RegisterScene_UTF16 (const std::wstring &uri, const std::string &scenetype)=0
virtual SceneResourcePtr	RegisterScene_UTF16 (const std::wstring &uri)
	registers scene with default scene type
virtual SceneResourcePtr	ImportSceneToCOLLADA_UTF8 (const std::string &sourceuri, const std::string &sourcescenetype, const std::string &newuri, bool overwrite=false)=0
	import a scene into COLLADA format using from scene identified by a URI
virtual SceneResourcePtr	ImportSceneToCOLLADA_UTF16 (const std::wstring &sourceuri, const std::string &sourcescenetype, const std::wstring &newuri, bool overwrite=false)=0
virtual void	SyncUpload_UTF8 (const std::string &sourcefilename, const std::string &destinationdir, const std::string &scenetype)=0
	Recommended way of uploading a scene's files into the network filesystem.
virtual void	SyncUpload_UTF8 (const std::string &sourcefilename, const std::string &destinationdir)
virtual void	SyncUpload_UTF16 (const std::wstring &sourcefilename, const std::wstring &destinationdir, const std::string &scenetype)=0
virtual void	SyncUpload_UTF16 (const std::wstring &sourcefilename, const std::wstring &destinationdir)
virtual void	UploadFileToController_UTF8 (const std::string &filename, const std::string &desturi)=0
	Uploads a single file to the controller network filesystem.
virtual void	UploadFileToController_UTF16 (const std::wstring &filename, const std::wstring &desturi)=0
virtual void	UploadDataToController_UTF8 (const std::vector< unsigned char > &vdata, const std::string &desturi)=0
	Uploads binary data to a single file on the controller network filesystem.
virtual void	UploadDirectoryToController_UTF8 (const std::string &copydir, const std::string &desturi)=0
	Recursively uploads a directory to the controller network filesystem.
virtual void	UploadDirectoryToController_UTF16 (const std::wstring &copydir, const std::wstring &desturi)=0
virtual void	DownloadFileFromController_UTF8 (const std::string &desturi, std::vector< unsigned char > &vdata)=0
virtual void	DownloadFileFromController_UTF16 (const std::wstring &desturi, std::vector< unsigned char > &vdata)=0
virtual void	DownloadFileFromControllerIfModifiedSince_UTF8 (const std::string &desturi, long localtimeval, long &remotetimeval, std::vector< unsigned char > &vdata)=0
virtual void	DownloadFileFromControllerIfModifiedSince_UTF16 (const std::wstring &desturi, long localtimeval, long &remotetimeval, std::vector< unsigned char > &vdata)=0
virtual void	DeleteFileOnController_UTF8 (const std::string &uri)=0
	Deletes a file on the controller network filesystem.
virtual void	DeleteFileOnController_UTF16 (const std::wstring &uri)=0
virtual void	DeleteDirectoryOnController_UTF8 (const std::string &uri)=0
	Recursively deletes a directory on the controller network filesystem.
virtual void	DeleteDirectoryOnController_UTF16 (const std::wstring &uri)=0
virtual void	SetDefaultSceneType (const std::string &scenetype)=0
virtual const std::string &	GetDefaultSceneType ()=0
virtual void	SetDefaultTaskType (const std::string &tasktype)=0
virtual const std::string &	GetDefaultTaskType ()=0
virtual std::string	GetScenePrimaryKeyFromURI_UTF8 (const std::string &uri)=0
	Get the url-encoded primary key of a scene from a scene uri (utf-8 encoded)
virtual std::string	GetScenePrimaryKeyFromURI_UTF16 (const std::wstring &uri)=0
	Get the url-encoded primary key of a scene from a scene uri (utf-16 encoded)
virtual std::string	GetPrimaryKeyFromName_UTF8 (const std::string &name)=0
	returns the primary key of a name
virtual std::string	GetPrimaryKeyFromName_UTF16 (const std::wstring &name)=0
	returns the primary key of a name
virtual std::string	GetNameFromPrimaryKey_UTF8 (const std::string &pk)=0
	returns the uncoded name from a primary key
virtual std::wstring	GetNameFromPrimaryKey_UTF16 (const std::string &pk)=0
	returns the uncoded name from a primary key

説明

Creates on MUJIN Controller instance.

Only one call can be made at a time. In order to make multiple calls simultaneously, create another instance.

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

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

virtual mujinclient::ControllerClient::~ControllerClient ( )

inlinevirtual

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

関数

virtual void mujinclient::ControllerClient::CancelAllJobs ( )

pure virtual

sends the cancel message to all jobs.

The method is non-blocking

virtual void mujinclient::ControllerClient::DeleteDirectoryOnController_UTF16 ( const std::wstring & uri )

pure virtual

参照: DeleteDirectoryOnController_UTF8

引数

uri	UTF-16 encoded

virtual void mujinclient::ControllerClient::DeleteDirectoryOnController_UTF8 ( const std::string & uri )

pure virtual

Recursively deletes a directory on the controller network filesystem.

引数

uri	UTF-8 encoded file in the network filesystem to delete.

virtual void mujinclient::ControllerClient::DeleteFileOnController_UTF16 ( const std::wstring & uri )

pure virtual

参照: DeleteFileOnController_UTF8

引数

uri	UTF-16 encoded file in the network filesystem to delete.

virtual void mujinclient::ControllerClient::DeleteFileOnController_UTF8 ( const std::string & uri )

pure virtual

Deletes a file on the controller network filesystem.

引数

uri	UTF-8 encoded file in the network filesystem to delete.

virtual void mujinclient::ControllerClient::DownloadFileFromController_UTF16	(	const std::wstring &	desturi,
		std::vector< unsigned char > &	vdata
	)

pure virtual

引数

vdata filled with the contents of the file on the controller filesystem

virtual void mujinclient::ControllerClient::DownloadFileFromController_UTF8	(	const std::string &	desturi,
		std::vector< unsigned char > &	vdata
	)

pure virtual

引数

vdata filled with the contents of the file on the controller filesystem

virtual void mujinclient::ControllerClient::DownloadFileFromControllerIfModifiedSince_UTF16	(	const std::wstring &	desturi,
		long	localtimeval,
		long &	remotetimeval,
		std::vector< unsigned char > &	vdata
	)

pure virtual

引数

localtimeval	seconds since epoch, will use input as If-Modified-Since header
remotetimeval	will output the modified date in response
vdata	filled with the contents of the file on the controller filesystem

virtual void mujinclient::ControllerClient::DownloadFileFromControllerIfModifiedSince_UTF8	(	const std::string &	desturi,
		long	localtimeval,
		long &	remotetimeval,
		std::vector< unsigned char > &	vdata
	)

pure virtual

引数

localtimeval	seconds since epoch, will use input as If-Modified-Since header
remotetimeval	will output the modified date in response
vdata	filled with the contents of the file on the controller filesystem

virtual const std::string& mujinclient::ControllerClient::GetDefaultSceneType ( )

pure virtual

virtual const std::string& mujinclient::ControllerClient::GetDefaultTaskType ( )

pure virtual

virtual std::wstring mujinclient::ControllerClient::GetNameFromPrimaryKey_UTF16 ( const std::string & pk )

pure virtual

returns the uncoded name from a primary key

戻り値: utf-16 encoded name

virtual std::string mujinclient::ControllerClient::GetNameFromPrimaryKey_UTF8 ( const std::string & pk )

pure virtual

returns the uncoded name from a primary key

戻り値: utf-8 encoded name

virtual std::string mujinclient::ControllerClient::GetPrimaryKeyFromName_UTF16 ( const std::wstring & name )

pure virtual

returns the primary key of a name

引数

name	utf-16 encoded

virtual std::string mujinclient::ControllerClient::GetPrimaryKeyFromName_UTF8 ( const std::string & name )

pure virtual

returns the primary key of a name

引数

name	utf-8 encoded

virtual void mujinclient::ControllerClient::GetRunTimeStatuses	(	std::vector< JobStatus > &	statuses,
		int	options = `0`
	)

pure virtual

get all the run-time statuses

引数

options if options is 1, also get the message

virtual std::string mujinclient::ControllerClient::GetScenePrimaryKeyFromURI_UTF16 ( const std::wstring & uri )

pure virtual

Get the url-encoded primary key of a scene from a scene uri (utf-16 encoded)

If input URL is L"mujin:/\u691c\u8a3c\u52d5\u4f5c_121122.mujin.dae" Return value will be: "%E6%A4%9C%E8%A8%BC%E5%8B%95%E4%BD%9C_121122"

引数

uri	utf-16 encoded URI

virtual std::string mujinclient::ControllerClient::GetScenePrimaryKeyFromURI_UTF8 ( const std::string & uri )

pure virtual

Get the url-encoded primary key of a scene from a scene uri (utf-8 encoded)

For example, the URI

mujin:/検証動作_121122.mujin.dae

is represented as:

"mujin:/\xe6\xa4\x9c\xe8\xa8\xbc\xe5\x8b\x95\xe4\xbd\x9c_121122.mujin.dae"

Return value will be: "%E6%A4%9C%E8%A8%BC%E5%8B%95%E4%BD%9C_121122"

引数

uri	utf-8 encoded URI

virtual void mujinclient::ControllerClient::GetScenePrimaryKeys ( std::vector< std::string > & scenekeys )

pure virtual

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

virtual const std::string& mujinclient::ControllerClient::GetUserName ( ) const

pure virtual

returns the username logged into this controller

virtual std::string mujinclient::ControllerClient::GetVersion ( )

pure virtual

returns the mujin controller version

virtual SceneResourcePtr mujinclient::ControllerClient::ImportSceneToCOLLADA_UTF16	(	const std::wstring &	sourceuri,
		const std::string &	sourcescenetype,
		const std::wstring &	newuri,
		bool	overwrite = `false`
	)

pure virtual

参照: ImportSceneToCOLLADA_UTF8

引数

sourceuri	utf-16 encoded
newuri	utf-16 encoded

virtual SceneResourcePtr mujinclient::ControllerClient::ImportSceneToCOLLADA_UTF8	(	const std::string &	sourceuri,
		const std::string &	sourcescenetype,
		const std::string &	newuri,
		bool	overwrite = `false`
	)

pure virtual

import a scene into COLLADA format using from scene identified by a URI

引数

sourceuri	URL-encoded UTF-8 original URI to import from. For MUJIN network files use mujin:/mypath/myfile.ext
sourcescenetype	The format of the source file. Can be: mujincollada wincaps (DensoWave WINCAPS III) rttoolbox (Mitsubishi RT ToolBox) x (DirectX) vrml stl cecrobodiaxml (CEC RoboDiA XML environments)
newuri	UTF-8 encoded new URI to save the imported results. Default is to save to MUJIN COLLADA, so end with .mujin.dae . Use mujin:/mypath/myfile.mujin.dae
overwrite	if true, will overwrite any existing scenes at newuri with the new scene.

virtual SceneResourcePtr mujinclient::ControllerClient::RegisterScene_UTF16	(	const std::wstring &	uri,
		const std::string &	scenetype
	)

pure virtual

参照: RegisterScene_UTF8

引数

uri	utf-16 encoded URI

virtual SceneResourcePtr mujinclient::ControllerClient::RegisterScene_UTF16 ( const std::wstring & uri )

inlinevirtual

registers scene with default scene type

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

virtual SceneResourcePtr mujinclient::ControllerClient::RegisterScene_UTF8	(	const std::string &	uri,
		const std::string &	scenetype
	)

pure virtual

Register a scene to be used by the MUJIN Controller.

引数

uri	utf-8 encoded URI of the file on the MUJIN Controller to import. Usually starts with mujin:/
scenetype	The format of the source file. Can be: mujincollada wincaps (DensoWave WINCAPS III) rttoolbox (Mitsubishi RT ToolBox) x (DirectX) vrml stl cecrobodiaxml (CEC RoboDiA XML environments)

virtual SceneResourcePtr mujinclient::ControllerClient::RegisterScene_UTF8 ( const std::string & uri )

inlinevirtual

registers scene with default scene type

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

virtual void mujinclient::ControllerClient::RestartServer ( )

pure virtual

Restarts the MUJIN Controller Server and destroys any optimizaiton jobs.

If the server is not responding, call this method to clear the server state and initialize everything. The method is blocking, when it returns the MUJIN Controller would have been restarted.

virtual void mujinclient::ControllerClient::SetCharacterEncoding ( const std::string & newencoding )

pure virtual

sets the character encoding for all strings that are being input and output from the resources

The default character encoding is utf-8, can also set it to Shift_JIS for windows japanese unicode, iso-2022-jp List of possible sets: http://www.iana.org/assignments/character-sets/character-sets.xml

virtual void mujinclient::ControllerClient::SetDefaultSceneType ( const std::string & scenetype )

pure virtual

virtual void mujinclient::ControllerClient::SetDefaultTaskType ( const std::string & tasktype )

pure virtual

virtual void mujinclient::ControllerClient::SetLanguage ( const std::string & language )

pure virtual

sets the language code for all output

Check out http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

virtual void mujinclient::ControllerClient::SetProxy	(	const std::string &	serverport,
		const std::string &	userpw
	)

pure virtual

If necessary, changes the proxy to communicate to the controller server.

引数

serverport	Specify proxy server to use. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option. If not specified, will default to using port 1080 for proxies. Setting to empty string will disable the proxy.
userpw	If non-empty, [user name]:[password] to use for the connection to the HTTP proxy.

virtual void mujinclient::ControllerClient::SyncUpload_UTF16	(	const std::wstring &	sourcefilename,
		const std::wstring &	destinationdir,
		const std::string &	scenetype
	)

pure virtual

参照: SyncUpload_UTF8

引数

sourcefilename	UTF-16 encoded. For Windows systems, the \ path separator has to be used. For Unix systems, the / path separator has to be used.
destinationdir	UTF-16 encoded
scenetype	UTF-16 encoded

virtual void mujinclient::ControllerClient::SyncUpload_UTF16	(	const std::wstring &	sourcefilename,
		const std::wstring &	destinationdir
	)

inlinevirtual

参照: SyncUpload

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

virtual void mujinclient::ControllerClient::SyncUpload_UTF8	(	const std::string &	sourcefilename,
		const std::string &	destinationdir,
		const std::string &	scenetype
	)

pure virtual

Recommended way of uploading a scene's files into the network filesystem.

Depending on the scenetype, can upload entire directory trees.

引数

sourcefilename	UTF-8 encoded local filesystem location of the top-level file. If the scenetype requires many files, will upload all of them. For Windows systems, the \ path separator has to be used. For Unix systems, the / path separator has to be used.
destinationdir	UTF-8 encoded destination folder in the network file system. Should always have trailing slash. By default prefix with "mujin:/". Use the / separator for different paths.
scenetype	UTF-8 encoded type of scene uploading.

例外

mujin_exception if the upload fails, will throw an exception

virtual void mujinclient::ControllerClient::SyncUpload_UTF8	(	const std::string &	sourcefilename,
		const std::string &	destinationdir
	)

inlinevirtual

参照: SyncUpload_UTF8

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

virtual void mujinclient::ControllerClient::Upgrade ( const std::vector< unsigned char > & vdata )

pure virtual

Upgrade the controller with this data.

virtual void mujinclient::ControllerClient::UploadDataToController_UTF8	(	const std::vector< unsigned char > &	vdata,
		const std::string &	desturi
	)

pure virtual

Uploads binary data to a single file on the controller network filesystem.

Overwrites the destination uri if it already exists

引数

data	binary data to upload to the uri
desturi	UTF-8 encoded destination file in the network filesystem. By default prefix with "mujin:/". Use the / separator for different paths.

virtual void mujinclient::ControllerClient::UploadDirectoryToController_UTF16	(	const std::wstring &	copydir,
		const std::wstring &	desturi
	)

pure virtual

参照: UploadDirectoryToController_UTF8

引数

copydir	is utf-16 encoded
desturi	UTF-16 encoded

virtual void mujinclient::ControllerClient::UploadDirectoryToController_UTF8	(	const std::string &	copydir,
		const std::string &	desturi
	)

pure virtual

Recursively uploads a directory to the controller network filesystem.

Creates directories along the way if they don't exist. By default, overwrites all the files

引数

copydir	is utf-8 encoded. Cannot have trailing slashes '/', '\'
desturi	UTF-8 encoded destination file in the network filesystem. If it has a trailing slash, then copydir is inside that URL. If there is no trailing slash, the copydir directory is renamed to the URI. By default prefix with "mujin:/". Use the / separator for different paths.

virtual void mujinclient::ControllerClient::UploadFileToController_UTF16	(	const std::wstring &	filename,
		const std::wstring &	desturi
	)

pure virtual

参照: UploadFileToController_UTF8

引数

filename	utf-16 encoded
desturi	UTF-16 encoded

virtual void mujinclient::ControllerClient::UploadFileToController_UTF8	(	const std::string &	filename,
		const std::string &	desturi
	)

pure virtual

Uploads a single file to the controller network filesystem.

Overwrites the file if it already exists

引数

filename	utf-8 encoded path of the file on the system
desturi	UTF-8 encoded destination file in the network filesystem. By default prefix with "mujin:/". Use the / separator for different paths.

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

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

Public メソッド

説明

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

関数