Choreonoid  1.5
Public Member Functions | Protected Member Functions | List of all members
cnoid::ScriptItem Class Referenceabstract

#include <ScriptItem.h>

Inheritance diagram for cnoid::ScriptItem:
cnoid::AbstractTextItem cnoid::Item cnoid::Referenced cnoid::PythonScriptItem cnoid::SimulationScriptItem cnoid::PythonSimScriptItem

Public Member Functions

 ScriptItem ()
 
 ScriptItem (const ScriptItem &org)
 
virtual const std::string & textFilename () const
 
virtual const std::string & scriptFilename () const =0
 
virtual std::string identityName () const
 
virtual bool setBackgroundMode (bool on)
 
virtual bool isBackgroundMode () const
 
virtual bool isRunning () const
 
virtual bool execute ()=0
 
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 ()
 
const std::string & name () const
 
virtual void setName (const std::string &name)
 
bool hasAttribute (Attribute attribute) const
 
ItemchildItem () const
 
ItemprevItem () const
 
ItemnextItem () const
 
ItemparentItem () const
 
bool addChildItem (Item *item, bool isManualOperation=false)
 
bool addSubItem (Item *item)
 
bool isSubItem () const
 
void detachFromParentItem ()
 
void emitSigDetachedFromRootForSubTree ()
 
bool insertChildItem (Item *item, Item *nextItem, bool isManualOperation=false)
 
bool insertSubItem (Item *item, Item *nextItem)
 
bool isTemporal () const
 
void setTemporal (bool on=true)
 
RootItemfindRootItem () const
 
ItemfindItem (const std::string &path) const
 
template<class ItemType >
ItemType * findItem (const std::string &path) const
 
template<class ItemType >
ItemType * find (const std::string &path)
 
ItemfindChildItem (const std::string &path) const
 
template<class ItemType >
ItemType * findChildItem (const std::string &path) const
 
ItemfindSubItem (const std::string &path) const
 
template<class ItemType >
ItemType * findSubItem (const std::string &path) const
 
ItemheadItem () const
 
template<class ItemType >
ItemType * findOwnerItem (bool includeSelf=false)
 
bool isOwnedBy (Item *item) const
 
bool traverse (boost::function< bool(Item *)> function)
 
template<class ItemType >
bool traverse (boost::function< bool(ItemType *item)> function)
 
Itemduplicate () const
 
ItemduplicateAll () const
 
void assign (Item *srcItem)
 
bool load (const std::string &filename, const std::string &format=std::string())
 
bool load (const std::string &filename, Item *parent, const std::string &format=std::string())
 
bool save (const std::string &filename, const std::string &format=std::string())
 
bool overwrite (bool forceOverwrite=false, const std::string &format=std::string())
 
const std::string & filePath () const
 
const std::string & fileFormat () const
 
std::time_t fileModificationTime () const
 
bool isConsistentWithFile () const
 
void clearFileInformation ()
 
void suggestFileUpdate ()
 
void putProperties (PutPropertyFunction &putProperty)
 
virtual void notifyUpdate ()
 
SignalProxy< void(const std::string &oldName)> sigNameChanged ()
 
SignalProxy< void()> sigUpdated ()
 
SignalProxy< void()> sigPositionChanged ()
 
SignalProxy< void()> sigDetachedFromRoot ()
 
SignalProxy< void()> sigDisconnectedFromRoot ()
 
SignalProxy< void()> sigSubTreeChanged ()
 
virtual bool store (Archive &archive)
 
virtual bool restore (const Archive &archive)
 
ReferencedcustomData (int id)
 
const ReferencedcustomData (int id) const
 
void setCustomData (int id, ReferencedPtr data)
 
void clearCustomData (int id)
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 
void addRef ()
 
void releaseRef ()
 

Protected Member Functions

virtual ~ScriptItem ()
 
- Protected Member Functions inherited from cnoid::AbstractTextItem
virtual ~AbstractTextItem ()
 
- Protected Member Functions inherited from cnoid::Item
 Item ()
 
 Item (const Item &item)
 
virtual void onConnectedToRoot ()
 
virtual void onDisconnectedFromRoot ()
 
virtual void onPositionChanged ()
 
virtual bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
virtual ItemdoDuplicate () const
 
virtual void doAssign (Item *srcItem)
 
virtual void doPutProperties (PutPropertyFunction &putProperty)
 
void setAttribute (Attribute attribute)
 
void unsetAttribute (Attribute attribute)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 

Additional Inherited Members

- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 
- Static Public Member Functions inherited from cnoid::Item
static Itemfind (const std::string &path)
 
static SignalProxy< void(const char *type_info_name)> sigClassUnregistered ()
 

Constructor & Destructor Documentation

◆ ScriptItem() [1/2]

ScriptItem::ScriptItem ( )

◆ ScriptItem() [2/2]

ScriptItem::ScriptItem ( const ScriptItem org)

◆ ~ScriptItem()

ScriptItem::~ScriptItem ( )
protectedvirtual

Member Function Documentation

◆ execute()

virtual bool cnoid::ScriptItem::execute ( )
pure virtual

◆ executeCode()

bool ScriptItem::executeCode ( const char *  code)
virtual

This function executes the code in the same namespace as that of the script exection.

Note
Implementing this function is optional.

Reimplemented in cnoid::PythonSimScriptItem, and cnoid::PythonScriptItem.

◆ identityName()

std::string ScriptItem::identityName ( ) const
virtual

◆ isBackgroundMode()

bool ScriptItem::isBackgroundMode ( ) const
virtual

◆ isRunning()

bool ScriptItem::isRunning ( ) const
virtual

◆ resultString()

std::string ScriptItem::resultString ( ) const
virtual

◆ scriptFilename()

virtual const std::string& cnoid::ScriptItem::scriptFilename ( ) const
pure virtual

◆ setBackgroundMode()

bool ScriptItem::setBackgroundMode ( bool  on)
virtual

◆ sigScriptFinished()

virtual SignalProxy<void()> cnoid::ScriptItem::sigScriptFinished ( )
pure virtual

◆ terminate()

virtual bool cnoid::ScriptItem::terminate ( )
pure virtual

◆ textFilename()

const std::string & ScriptItem::textFilename ( ) const
virtual

◆ waitToFinish()

bool ScriptItem::waitToFinish ( double  timeout = 0.0)
virtual

This function waits for the script to finish.

Returns
True if the script is actually finished, or false if timeout happens.
Note
Implementing this function is optional. The function returns false if the function is not implemented.

Reimplemented in cnoid::PythonSimScriptItem, and cnoid::PythonScriptItem.


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