cnoid::SimulationScriptItem Class Reference

#include <SimulationScriptItem.h>

Inheritance diagram for cnoid::SimulationScriptItem:

Public Types
enum	ExecutionTiming {   BEFORE_INITIALIZATION, DURING_INITIALIZATION, AFTER_INITIALIZATION, DURING_FINALIZATION,   AFTER_FINALIZATION, NUM_TIMINGS }
Public Types inherited from cnoid::Item
enum	Attribute {   SubItem, Attached, Temporal, LoadOnly,   NumAttributes, SUB_ITEM = SubItem, TEMPORAL = Temporal, LOAD_ONLY = LoadOnly }
enum	CheckId { LogicalSumOfAllChecks = -1, PrimaryCheck = 0 }
typedef std::function< bool(Item *item)>	ItemPredicate

Public Member Functions
	SimulationScriptItem ()
	SimulationScriptItem (const SimulationScriptItem &org)
ExecutionTiming	executionTiming () const
void	setExecutionTiming (ExecutionTiming timing)
double	executionDelay () const
void	setExecutionDelay (double t)
virtual bool	execute ()
virtual bool	executeAsSimulationScript ()=0
Public Member Functions inherited from cnoid::ScriptItem
	ScriptItem ()
	ScriptItem (const ScriptItem &org)
virtual const std::string &	textFilename () const
virtual const std::string &	scriptFilename () const =0
virtual std::string	identityName () const
virtual void	setBackgroundMode (bool on)=0
virtual bool	isBackgroundMode () const
virtual bool	isRunning () const
virtual bool	executeCode (const char *code)
virtual bool	waitToFinish (double timeout=0.0)
virtual std::string	resultString () const
virtual SignalProxy< void()>	sigScriptFinished ()=0
virtual bool	terminate ()=0
Public Member Functions inherited from cnoid::AbstractTextItem
	AbstractTextItem ()
	AbstractTextItem (const AbstractTextItem &org)
Public Member Functions inherited from cnoid::Item
virtual	~Item ()
Item &	operator= (const Item &rhs)=delete
int	classId () const
Item *	createNewInstance () const
void	assign (Item *srcItem)
	Copy item properties as much as possible like the assignment operator. More...
Item *	duplicate (Item *duplicatedParentItem=nullptr) const
Item *	duplicateSubTree () const
	This function creates a copy of the item including its descendant items. More...
Item *	duplicateAll () const
const std::string &	name () const
virtual bool	setName (const std::string &name)
virtual std::string	displayName () const
void	setDisplayNameModifier (std::function< std::string(const Item *item)> modifier)
SignalProxy< void(const std::string &oldName)>	sigNameChanged ()
void	notifyNameChange ()
	This function notifies the system of a displayName change. More...
void	setAttribute (Attribute attribute)
void	unsetAttribute (Attribute attribute)
bool	hasAttribute (Attribute attribute) const
bool	isSubItem () const
void	setSubItemAttributes ()
bool	isTemporal () const
void	setTemporal (bool on=true)
bool	isSelected () const
void	setSelected (bool on, bool isCurrent=false)
void	setSubTreeItemsSelected (bool on)
bool	isChecked (int checkId=PrimaryCheck) const
void	setChecked (bool on)
void	setChecked (int checkId, bool on)
int	numCheckStates () const
int	numChildren () const
int	countDescendantItems () const
Item *	childItem () const
Item *	prevItem () const
Item *	nextItem () const
Item *	lastChildItem () const
Item *	parentItem () const
Item *	headItem () const
RootItem *	findRootItem () const
bool	isConnectedToRoot () const
Item *	localRootItem () const
bool	addChildItem (Item *item, bool isManualOperation=false)
bool	insertChildItem (Item *item, Item *nextItem, bool isManualOperation=false)
bool	insertChild (Item *position, Item *item, bool isManualOperation=false)
bool	addSubItem (Item *item)
bool	insertSubItem (Item *item, Item *nextItem)
void	removeFromParentItem ()
void	detachFromParentItem ()
void	clearChildren ()
template<class ItemType >
ItemType *	find (const std::string &path="")
Item *	findItem (const std::string &path) const
template<class ItemType >
ItemType *	findItem (const std::string &path) const
template<class ItemType >
ItemType *	findItem (std::function< bool(ItemType *item)> pred=nullptr) const
Item *	findChildItem (const std::string &path, std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemType *	findChildItem (const std::string &path, std::function< bool(ItemType *item)> pred=nullptr) const
template<class ItemType >
ItemType *	findChildItem (std::function< bool(ItemType *item)> pred=nullptr) const
Item *	findSubItem (const std::string &path) const
template<class ItemType >
ItemType *	findSubItem (const std::string &path="") const
template<class ItemType >
ItemType *	findOwnerItem (bool includeSelf=false) const
bool	isOwnedBy (Item *item) const
ItemList	childItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	childItems (std::function< bool(ItemType *item)> pred=nullptr) const
ItemList	descendantItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	descendantItems (std::function< bool(ItemType *item)> pred=nullptr) const
ItemList	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const
template<class ItemType >
ItemList< ItemType >	selectedDescendantItems (std::function< bool(Item *item)> pred=nullptr) const
bool	traverse (std::function< bool(Item *)> pred)
template<class ItemType >
bool	traverse (std::function< bool(ItemType *item)> pred=nullptr)
SignalProxy< void()>	sigTreePathChanged ()
SignalProxy< void()>	sigTreePositionChanged ()
SignalProxy< void(Item *topItem, Item *prevTopParentItem)>	sigTreePositionChanged2 ()
SignalProxy< void()>	sigPositionChanged ()
SignalProxy< void()>	sigSubTreeChanged ()
SignalProxy< void()>	sigDisconnectedFromRoot ()
SignalProxy< void()>	sigDetachedFromRoot ()
SignalProxy< void(bool on)>	sigSelectionChanged ()
SignalProxy< void(int checkId, bool on)>	sigAnyCheckToggled ()
SignalProxy< void(bool on)>	sigCheckToggled (int checkId=PrimaryCheck)
virtual void	notifyUpdate ()
SignalProxy< void()>	sigUpdated ()
bool	setAddon (ItemAddon *addon)
void	removeAddon (ItemAddon *addon)
template<class AddonType >
AddonType *	findAddon ()
template<class AddonType >
AddonType *	getAddon ()
std::vector< ItemAddon * >	addons ()
bool	load (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	load (const std::string &filename, Item *parent, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	save (const std::string &filename, const std::string &format=std::string(), const Mapping *options=nullptr)
bool	overwrite (bool forceOverwrite=false, const std::string &format=std::string())
const std::string &	filePath () const
	Full path file name. More...
std::string	fileName () const
	File name without the directory. More...
const std::string &	fileFormat () const
const Mapping *	fileOptions () const
std::time_t	fileModificationTime () const
bool	isConsistentWithFile () const
void	updateFileInformation (const std::string &filename, const std::string &format, Mapping *options=nullptr)
void	setConsistentWithFile (bool isConsistent)
void	suggestFileUpdate ()
void	clearFileInformation ()
	Use this function to disable the implicit overwrite next time. More...
bool	reload ()
bool	replace (Item *originalItem)
Item *	findOriginalItem () const
Item *	findReplacementItem () const
void	putProperties (PutPropertyFunction &putProperty)
Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Static Public Member Functions
static void	initializeClass (ExtensionManager *ext)
Static Public Member Functions inherited from cnoid::ScriptItem
static void	initializeClass (ExtensionManager *ext)
Static Public Member Functions inherited from cnoid::AbstractTextItem
static void	initializeClass (ExtensionManager *ext)
Static Public Member Functions inherited from cnoid::Item
template<class ItemType >
static ItemPredicate	getItemPredicate ()
template<class ItemType >
static ItemPredicate	getItemPredicate (std::function< bool(ItemType *item)> pred)
static Item *	find (const std::string &path)

Protected Member Functions
virtual	~SimulationScriptItem ()
virtual void	doPutProperties (PutPropertyFunction &putProperty)
virtual bool	store (Archive &archive)
virtual bool	restore (const Archive &archive)
Protected Member Functions inherited from cnoid::ScriptItem
virtual	~ScriptItem ()
Protected Member Functions inherited from cnoid::AbstractTextItem
virtual	~AbstractTextItem ()
Protected Member Functions inherited from cnoid::Item
	Item ()
	Item (const std::string &name)
	Item (const Item &item)
virtual void	doAssign (Item *srcItem)
	Implement the code to copy properties like the assingment operator. More...
virtual Item *	doDuplicate () const
	Override this function to allow duplication of an instance. More...
virtual Item *	doDuplicate (Item *duplicatedParentItem) const
virtual bool	onNewTreePositionCheck (bool isManualOperation, std::function< void()> &out_callbackWhenAdded)
virtual void	onAddedToParent ()
virtual void	onTreePathChanged ()
virtual void	onTreePositionChanged ()
virtual void	onPositionChanged ()
virtual void	onConnectedToRoot ()
virtual void	onRemovedFromParent (Item *parentItem, bool isParentBeingDeleted)
virtual void	onDisconnectedFromRoot ()
virtual bool	onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
Protected Member Functions inherited from cnoid::Referenced
	Referenced ()
	Referenced (const Referenced &)
int	refCount () const

Friends
class	SimulationScriptItemImpl

Member Enumeration Documentation

ExecutionTiming

enum cnoid::SimulationScriptItem::ExecutionTiming

Enumerator
BEFORE_INITIALIZATION
DURING_INITIALIZATION
AFTER_INITIALIZATION
DURING_FINALIZATION
AFTER_FINALIZATION
NUM_TIMINGS

Constructor & Destructor Documentation

SimulationScriptItem() [1/2]

SimulationScriptItem::SimulationScriptItem

(

)

SimulationScriptItem() [2/2]

SimulationScriptItem::SimulationScriptItem

(

const SimulationScriptItem &

org

)

~SimulationScriptItem()

SimulationScriptItem::~SimulationScriptItem ( )

protectedvirtual

Member Function Documentation

doPutProperties()

void SimulationScriptItem::doPutProperties ( PutPropertyFunction &  putProperty )

protectedvirtual

This function is used to put a standard properties of the item. You can implement the standard properties by overriding this function.

Note

The overridden function should call the same function of the parent class.

Reimplemented from cnoid::Item.

Reimplemented in cnoid::PythonSimScriptItem.

execute()

bool SimulationScriptItem::execute ( )

virtual

Implements cnoid::ScriptItem.

executeAsSimulationScript()

virtual bool cnoid::SimulationScriptItem::executeAsSimulationScript ( )

pure virtual

Implemented in cnoid::PythonSimScriptItem.

executionDelay()

double SimulationScriptItem::executionDelay

(

)

const

executionTiming()

SimulationScriptItem::ExecutionTiming SimulationScriptItem::executionTiming

(

)

const

initializeClass()

void SimulationScriptItem::initializeClass ( ExtensionManager *  ext )

static

restore()

bool SimulationScriptItem::restore ( const Archive &  archive )

protectedvirtual

Reimplemented from cnoid::Item.

Reimplemented in cnoid::PythonSimScriptItem.

setExecutionDelay()

void SimulationScriptItem::setExecutionDelay

(

double

t

)

setExecutionTiming()

void SimulationScriptItem::setExecutionTiming

(

SimulationScriptItem::ExecutionTiming

timing

)

store()

bool SimulationScriptItem::store ( Archive &  archive )

protectedvirtual

Reimplemented from cnoid::Item.

Reimplemented in cnoid::PythonSimScriptItem.

Friends And Related Function Documentation

SimulationScriptItemImpl

friend class SimulationScriptItemImpl

friend

---

The documentation for this class was generated from the following files:

• SimulationScriptItem.h
• SimulationScriptItem.cpp