Choreonoid  1.8
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cnoid::PythonScriptItem Class Reference

#include <PythonScriptItem.h>

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

Public Member Functions

 PythonScriptItem ()
 
 PythonScriptItem (const PythonScriptItem &org)
 
bool setScriptFilename (const std::string &filename)
 
virtual const std::string & scriptFilename () const override
 
virtual void setBackgroundMode (bool on) override
 
virtual bool isBackgroundMode () const override
 
virtual bool isRunning () const override
 
virtual bool execute () override
 
virtual bool executeCode (const char *code) override
 
virtual bool waitToFinish (double timeout=0.0) override
 
virtual std::string resultString () const override
 
virtual SignalProxy< void()> sigScriptFinished () override
 
virtual bool terminate () override
 
- 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 ()
 
Itemoperator= (const Item &rhs)=delete
 
int classId () const
 
ItemcreateNewInstance () const
 
void assign (Item *srcItem)
 Copy item properties as much as possible like the assignment operator. More...
 
Itemduplicate (Item *duplicatedParentItem=nullptr) const
 
ItemduplicateSubTree () const
 This function creates a copy of the item including its descendant items. More...
 
ItemduplicateAll () 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
 
ItemchildItem () const
 
ItemprevItem () const
 
ItemnextItem () const
 
ItemlastChildItem () const
 
ItemparentItem () const
 
ItemheadItem () const
 
RootItemfindRootItem () const
 
bool isConnectedToRoot () const
 
ItemlocalRootItem () 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="")
 
ItemfindItem (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
 
ItemfindChildItem (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
 
ItemfindSubItem (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 MappingfileOptions () 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)
 
ItemfindOriginalItem () const
 
ItemfindReplacementItem () 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 Itemfind (const std::string &path)
 

Protected Member Functions

virtual ~PythonScriptItem ()
 
virtual void onDisconnectedFromRoot () override
 
virtual ItemdoDuplicate () const override
 Override this function to allow duplication of an instance. More...
 
virtual void doPutProperties (PutPropertyFunction &putProperty) override
 
virtual bool store (Archive &archive) override
 
virtual bool restore (const Archive &archive) override
 
- 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 ItemdoDuplicate (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 bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
int refCount () const
 

Additional Inherited Members

- 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
 

Constructor & Destructor Documentation

◆ PythonScriptItem() [1/2]

PythonScriptItem::PythonScriptItem ( )

◆ PythonScriptItem() [2/2]

PythonScriptItem::PythonScriptItem ( const PythonScriptItem org)

◆ ~PythonScriptItem()

PythonScriptItem::~PythonScriptItem ( )
protectedvirtual

Member Function Documentation

◆ doDuplicate()

Item * PythonScriptItem::doDuplicate ( ) const
overrideprotectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ doPutProperties()

void PythonScriptItem::doPutProperties ( PutPropertyFunction putProperty)
overrideprotectedvirtual

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.

◆ execute()

bool PythonScriptItem::execute ( )
overridevirtual

Implements cnoid::ScriptItem.

◆ executeCode()

bool PythonScriptItem::executeCode ( const char *  code)
overridevirtual

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.

◆ initializeClass()

void PythonScriptItem::initializeClass ( ExtensionManager ext)
static

◆ isBackgroundMode()

bool PythonScriptItem::isBackgroundMode ( ) const
overridevirtual

Reimplemented from cnoid::ScriptItem.

◆ isRunning()

bool PythonScriptItem::isRunning ( ) const
overridevirtual

Reimplemented from cnoid::ScriptItem.

◆ onDisconnectedFromRoot()

void PythonScriptItem::onDisconnectedFromRoot ( )
overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ restore()

bool PythonScriptItem::restore ( const Archive archive)
overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ resultString()

std::string PythonScriptItem::resultString ( ) const
overridevirtual

Reimplemented from cnoid::ScriptItem.

◆ scriptFilename()

const std::string & PythonScriptItem::scriptFilename ( ) const
overridevirtual

Implements cnoid::ScriptItem.

◆ setBackgroundMode()

void PythonScriptItem::setBackgroundMode ( bool  on)
overridevirtual

Implements cnoid::ScriptItem.

◆ setScriptFilename()

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

◆ sigScriptFinished()

SignalProxy< void()> PythonScriptItem::sigScriptFinished ( )
overridevirtual

Implements cnoid::ScriptItem.

◆ store()

bool PythonScriptItem::store ( Archive archive)
overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ terminate()

bool PythonScriptItem::terminate ( )
overridevirtual

Implements cnoid::ScriptItem.

◆ waitToFinish()

bool PythonScriptItem::waitToFinish ( double  timeout = 0.0)
overridevirtual

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: