Choreonoid  1.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cnoid::PythonSimScriptItem Class Reference

#include <PythonSimScriptItem.h>

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

Public Member Functions

 PythonSimScriptItem ()
 
 PythonSimScriptItem (const PythonSimScriptItem &org)
 
virtual ~PythonSimScriptItem ()
 
bool setScriptFilename (const std::string &filename)
 
virtual const std::string & scriptFilename () const
 
virtual bool setBackgroundMode (bool on)
 
virtual bool isBackgroundMode () const
 
virtual bool isRunning () const
 
virtual bool executeAsSimulationScript ()
 
virtual bool executeCode (const char *code)
 
virtual bool waitToFinish (double timeout=0.0)
 
virtual std::string resultString () const
 
virtual SignalProxy< void()> sigScriptFinished ()
 
virtual bool terminate ()
 
- Public Member Functions inherited from cnoid::SimulationScriptItem
 SimulationScriptItem ()
 
 SimulationScriptItem (const SimulationScriptItem &org)
 
ExecutionTiming executionTiming () const
 
void setExecutionTiming (ExecutionTiming timing)
 
double executionDelay () const
 
void setExecutionDelay (double t)
 
virtual bool execute ()
 
- Public Member Functions inherited from cnoid::ScriptItem
 ScriptItem ()
 
 ScriptItem (const ScriptItem &org)
 
virtual const std::string & textFilename () const
 
virtual std::string identityName () const
 
- 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
 
Item * childItem () const
 
Item * prevItem () const
 
Item * nextItem () const
 
Item * parentItem () 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)
 
RootItem * findRootItem () const
 
Item * findItem (const std::string &path) const
 
template<class ItemType >
ItemType * findItem (const std::string &path) const
 
template<class ItemType >
ItemType * find (const std::string &path)
 
Item * findChildItem (const std::string &path) const
 
template<class ItemType >
ItemType * findChildItem (const std::string &path) const
 
Item * findSubItem (const std::string &path) const
 
template<class ItemType >
ItemType * findSubItem (const std::string &path) const
 
Item * headItem () 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)
 
Item * duplicate () const
 
Item * duplicateAll () 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 ()
 
Referenced * customData (int id)
 
const Referenced * customData (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 ()
 

Static Public Member Functions

static void initialize (ExtensionManager *ext)
 
- Static Public Member Functions inherited from cnoid::Item
static Item * find (const std::string &path)
 
static SignalProxy< void(const char *type_info_name)> sigClassUnregistered ()
 

Protected Member Functions

virtual void onDisconnectedFromRoot ()
 
virtual Item * doDuplicate () const
 
virtual void doPutProperties (PutPropertyFunction &putProperty)
 
virtual bool store (Archive &archive)
 
virtual bool restore (const Archive &archive)
 
- Protected Member Functions inherited from cnoid::SimulationScriptItem
virtual ~SimulationScriptItem ()
 
- 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 Item &item)
 
virtual void onConnectedToRoot ()
 
virtual void onPositionChanged ()
 
virtual bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
virtual void doAssign (Item *srcItem)
 
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::SimulationScriptItem
enum  ExecutionTiming {
  BEFORE_INITIALIZATION, DURING_INITIALIZATION, AFTER_INITIALIZATION, DURING_FINALIZATION,
  AFTER_FINALIZATION, NUM_TIMINGS
}
 
- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 

Constructor & Destructor Documentation

◆ PythonSimScriptItem() [1/2]

PythonSimScriptItem::PythonSimScriptItem ( )

◆ PythonSimScriptItem() [2/2]

PythonSimScriptItem::PythonSimScriptItem ( const PythonSimScriptItem &  org)

◆ ~PythonSimScriptItem()

PythonSimScriptItem::~PythonSimScriptItem ( )
virtual

Member Function Documentation

◆ doDuplicate()

Item * PythonSimScriptItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ doPutProperties()

void PythonSimScriptItem::doPutProperties ( PutPropertyFunction &  putProperty)
protectedvirtual

Override this function to put properties of the item.

Note
Please call doPutProperties() of the parent class in this function. For example, when your class directly inherits the Item class, call Item::doPutProperties(putProperty).

Reimplemented from cnoid::SimulationScriptItem.

◆ executeAsSimulationScript()

bool PythonSimScriptItem::executeAsSimulationScript ( )
virtual

Implements cnoid::SimulationScriptItem.

◆ executeCode()

bool PythonSimScriptItem::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 from cnoid::ScriptItem.

◆ initialize()

void PythonSimScriptItem::initialize ( ExtensionManager *  ext)
static

◆ isBackgroundMode()

bool PythonSimScriptItem::isBackgroundMode ( ) const
virtual

Reimplemented from cnoid::ScriptItem.

◆ isRunning()

bool PythonSimScriptItem::isRunning ( ) const
virtual

Reimplemented from cnoid::ScriptItem.

◆ onDisconnectedFromRoot()

void PythonSimScriptItem::onDisconnectedFromRoot ( )
protectedvirtual

Reimplemented from cnoid::Item.

◆ restore()

bool PythonSimScriptItem::restore ( const Archive &  archive)
protectedvirtual

Reimplemented from cnoid::SimulationScriptItem.

◆ resultString()

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

Reimplemented from cnoid::ScriptItem.

◆ scriptFilename()

const std::string & PythonSimScriptItem::scriptFilename ( ) const
virtual

Implements cnoid::ScriptItem.

◆ setBackgroundMode()

bool PythonSimScriptItem::setBackgroundMode ( bool  on)
virtual

Reimplemented from cnoid::ScriptItem.

◆ setScriptFilename()

bool PythonSimScriptItem::setScriptFilename ( const std::string &  filename)

◆ sigScriptFinished()

SignalProxy< void()> PythonSimScriptItem::sigScriptFinished ( )
virtual

Implements cnoid::ScriptItem.

◆ store()

bool PythonSimScriptItem::store ( Archive &  archive)
protectedvirtual

Reimplemented from cnoid::SimulationScriptItem.

◆ terminate()

bool PythonSimScriptItem::terminate ( )
virtual

Implements cnoid::ScriptItem.

◆ waitToFinish()

bool PythonSimScriptItem::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 from cnoid::ScriptItem.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13