Choreonoid  1.5
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
cnoid::SimulationScriptItem Class Referenceabstract

#include <SimulationScriptItem.h>

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

Public Types

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 }
 

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 bool setBackgroundMode (bool on)
 
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 ()
 
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 ()
 
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 ~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 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)
 
void setAttribute (Attribute attribute)
 
void unsetAttribute (Attribute attribute)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 

Friends

class SimulationScriptItemImpl
 

Additional Inherited Members

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

Member Enumeration Documentation

◆ 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

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::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

◆ 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: