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

#include <RootItem.h>

Inheritance diagram for cnoid::RootItem:
cnoid::Item cnoid::Referenced

Public Member Functions

 RootItem ()
 
 RootItem (const RootItem &org)
 
virtual ~RootItem ()
 
SignalProxy< void(RootItem *rootItem)> sigDestroyed ()
 
SignalProxy< void(Item *item)> sigSubTreeAdded ()
 
SignalProxy< void(Item *item)> sigItemAdded ()
 
SignalProxy< void(Item *item)> sigSubTreeMoved ()
 
SignalProxy< void(Item *item)> sigItemMoved ()
 
SignalProxy< void(Item *item, bool isMoving)> sigSubTreeRemoving ()
 
SignalProxy< void(Item *item, bool isMoving)> sigSubTreeRemoved ()
 
SignalProxy< void()> sigTreeChanged ()
 
SignalProxy< void(Item *assigned, Item *srcItem)> sigItemAssigned ()
 
- 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 ()
 

Static Public Member Functions

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

Protected Member Functions

virtual ItemdoDuplicate () const
 
virtual bool store (Archive &archive)
 
virtual bool restore (const Archive &archive)
 
- 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 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
 

Friends

class Item
 
class RootItemImpl
 

Additional Inherited Members

- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 

Constructor & Destructor Documentation

◆ RootItem() [1/2]

RootItem::RootItem ( )

◆ RootItem() [2/2]

RootItem::RootItem ( const RootItem org)

◆ ~RootItem()

RootItem::~RootItem ( )
virtual

Member Function Documentation

◆ doDuplicate()

Item * RootItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ initializeClass()

void RootItem::initializeClass ( ExtensionManager ext)
static

◆ instance()

RootItem * RootItem::instance ( )
static

◆ mainInstance()

RootItem * RootItem::mainInstance ( )
static

◆ restore()

bool RootItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

◆ sigDestroyed()

SignalProxy< void(RootItem *rootItem)> RootItem::sigDestroyed ( )

◆ sigItemAdded()

SignalProxy< void(Item *item)> RootItem::sigItemAdded ( )

◆ sigItemAssigned()

SignalProxy< void(Item *assigned, Item *srcItem)> RootItem::sigItemAssigned ( )

This signal is emitted when Item::asign() is called.

◆ sigItemMoved()

SignalProxy< void(Item *item)> RootItem::sigItemMoved ( )

◆ sigSubTreeAdded()

SignalProxy< void(Item *item)> RootItem::sigSubTreeAdded ( )

◆ sigSubTreeMoved()

SignalProxy< void(Item *item)> RootItem::sigSubTreeMoved ( )

◆ sigSubTreeRemoved()

SignalProxy< void(Item *item, bool isMoving)> RootItem::sigSubTreeRemoved ( )

◆ sigSubTreeRemoving()

SignalProxy< void(Item *item, bool isMoving)> RootItem::sigSubTreeRemoving ( )

◆ sigTreeChanged()

SignalProxy< void()> RootItem::sigTreeChanged ( )

◆ store()

bool RootItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

Friends And Related Function Documentation

◆ Item

friend class Item
friend

◆ RootItemImpl

friend class RootItemImpl
friend

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