qi Namespace Reference

Namespaces
	detail

Classes
struct	BehaviorModel
class	Behavior
class	ProgressNotifier
class	File
class	FileOperation
class	LogListener
class	LogManager
struct	LogMessage
class	LogProvider
class	TaskCall
class	TaskCall< Future< T > >
class	Task

Typedefs
typedef qi::Object < ProgressNotifier >	ProgressNotifierPtr
	Pointer to a ProgressNotifier with shared/remote semantic. More...
typedef qi::Object< File >	FilePtr
	Pointer to a file with shared/remote semantic. More...
typedef boost::shared_ptr < FileOperation >	FileOperationPtr
	Pointer to a file operation. More...
typedef qi::Object< LogListener >	LogListenerPtr
typedef qi::Object< LogProvider >	LogProviderPtr
typedef qi::Object< LogManager >	LogManagerPtr

Functions
BehaviorModel	loadBehaviorModel (const qilang::NodePtrVector &nodes)
void	displayModel (const BehaviorModel &model)
	QI_REGISTER_OBJECT (Behavior, loadObjects, unloadObjects, setTransitions, removeTransitions, loadFile, loadString, call, onTransition, model, objects, transitions, setModel, onTaskRunning, onTaskError, object, start, stop, onStart, onStop)
ProgressNotifierPtr	createProgressNotifier ()
FilePtr	openLocalFile (const qi::Path &localPath)
FileOperationPtr	prepareCopyToLocal (FilePtr file, const Path &localPath)
FutureSync< void >	copyToLocal (FilePtr file, const Path &localPath)
LogProviderPtr	makeLogProvider (LogManagerPtr logger)
LogProviderPtr	makeLogProvider ()
qi::FutureSync < qi::LogProviderPtr >	initializeLogging (SessionPtr session, const std::string &categoryPrefix="")

Detailed Description

Author

Aldebaran Robotics Aldebaran Robotics (c) 2013 All Rights Reserved

Typedef Documentation

typedef boost::shared_ptr<FileOperation> qi::FileOperationPtr

Pointer to a file operation.

Definition at line 215 of file file.hpp.

typedef qi::Object<File> qi::FilePtr

Pointer to a file with shared/remote semantic.

Definition at line 185 of file file.hpp.

typedef qi::Object< LogListener > qi::LogListenerPtr

Definition at line 58 of file loglistener.hpp.

typedef qi::Object< LogManager > qi::LogManagerPtr

Definition at line 42 of file logmanager.hpp.

typedef qi::Object< LogProvider > qi::LogProviderPtr

Definition at line 22 of file logmanager.hpp.

typedef qi::Object<ProgressNotifier> qi::ProgressNotifierPtr

Pointer to a ProgressNotifier with shared/remote semantic.

Definition at line 94 of file file.hpp.

Function Documentation

FutureSync<void> qi::copyToLocal	(	FilePtr	file,
		const Path &	localPath
	)

Copy an open local or remote file to a local filesystem location.

Parameters

file	Source file to copy.
localPath	Local filesystem location where the specified file will be copied. No file or directory should be located at this path otherwise the operation will fail.

Returns

A synchronous future associated with the operation.

ProgressNotifierPtr qi::createProgressNotifier

(

)

Returns

Create and provide a remotely shareable ProgressNotifier object.

void qi::displayModel

(

const BehaviorModel &

model

)

qi::FutureSync<qi::LogProviderPtr> qi::initializeLogging	(	SessionPtr	session,
		const std::string &	categoryPrefix = ""
	)

BehaviorModel qi::loadBehaviorModel

(

const qilang::NodePtrVector &

nodes

)

LogProviderPtr qi::makeLogProvider

(

LogManagerPtr

logger

)

LogProviderPtr qi::makeLogProvider

(

)

FilePtr qi::openLocalFile

(

const qi::Path &

localPath

)

Open a local file located at the specified path and provide it for reading as a sharable file access.

Warning

Throws a std::runtime_exception if the provided path is not an existing file path.

Parameters

localPath

Path to a file on the local file system that can be open.

Returns

A shareable access to the opened local file.

FileOperationPtr qi::prepareCopyToLocal	(	FilePtr	file,
		const Path &	localPath
	)

Setup the following operation: a copy of local or remote file to a local filesystem location.

Parameters

file	Source file to copy.
localPath	Local filesystem location where the specified file will be copied. No file or directory should be located at this path otherwise the operation will fail.

Returns

This operation ready to be started but not executed yet.

qi::QI_REGISTER_OBJECT	(	Behavior	,
		loadObjects	,
		unloadObjects	,
		setTransitions	,
		removeTransitions	,
		loadFile	,
		loadString	,
		call	,
		onTransition	,
		model	,
		objects	,
		transitions	,
		setModel	,
		onTaskRunning	,
		onTaskError	,
		object	,
		start	,
		stop	,
		onStart	,
		onStop
	)