Choreonoid  1.8
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(Item *assigned, Item *srcItem)> sigItemAssigned ()
 
SignalProxy< void(Item *item, const std::string &oldName)> sigItemNameChanged ()
 
SignalProxy< void()> sigTreeChanged ()
 
ItemcurrentItem ()
 
template<class ItemType >
ItemList< ItemType > selectedItems ()
 
const ItemListselectedItems ()
 
void selectItem (Item *item)
 
SignalProxy< void(Item *item, bool on)> sigSelectionChanged ()
 
SignalProxy< void(const ItemList<> &selectedItems)> sigSelectedItemsChanged ()
 
void beginItemSelectionChanges ()
 
void endItemSelectionChanges ()
 
int addCheckEntry (const std::string &description)
 
int numCheckEntries () const
 
const std::string & checkEntryDescription (int checkId) const
 
void releaseCheckEntry (int checkId)
 
SignalProxy< void(int checkId)> sigCheckEntryAdded ()
 
SignalProxy< void(int checkId)> sigCheckEntryReleased ()
 
bool storeCheckStates (int checkId, Archive &archive, const std::string &key)
 
bool restoreCheckStates (int checkId, const Archive &archive, const std::string &key)
 
template<class ItemType >
ItemList< ItemType > checkedItems (int checkId=PrimaryCheck)
 
const ItemListcheckedItems ()
 
SignalProxy< void(Item *item, bool on)> sigCheckToggled (int checkId=PrimaryCheck)
 
- 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 RootIteminstance ()
 
static RootItemmainInstance ()
 
- 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 ItemdoDuplicate () const override
 Override this function to allow duplication of an instance. More...
 
virtual bool store (Archive &archive) override
 
virtual bool restore (const Archive &archive) override
 
- 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 void onDisconnectedFromRoot ()
 
virtual bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
virtual void doPutProperties (PutPropertyFunction &putProperty)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
int refCount () const
 

Friends

class Item
 

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
 

Detailed Description

The class of the item that is the root of the item tree structure

Constructor & Destructor Documentation

◆ RootItem() [1/2]

RootItem::RootItem ( )

◆ RootItem() [2/2]

RootItem::RootItem ( const RootItem org)

◆ ~RootItem()

RootItem::~RootItem ( )
virtual

Member Function Documentation

◆ addCheckEntry()

int RootItem::addCheckEntry ( const std::string &  description)
Returns
The state id of the new check state.

◆ beginItemSelectionChanges()

void RootItem::beginItemSelectionChanges ( )

◆ checkedItems() [1/2]

const ItemList& cnoid::RootItem::checkedItems ( )
inline

◆ checkedItems() [2/2]

template<class ItemType >
ItemList<ItemType> cnoid::RootItem::checkedItems ( int  checkId = PrimaryCheck)
inline
Note
Item::LogicalSumOfAllChecks is not supported

◆ checkEntryDescription()

const std::string & RootItem::checkEntryDescription ( int  checkId) const

◆ currentItem()

Item * RootItem::currentItem ( )

◆ doDuplicate()

Item * RootItem::doDuplicate ( ) const
overrideprotectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

◆ endItemSelectionChanges()

void RootItem::endItemSelectionChanges ( )

◆ initializeClass()

void RootItem::initializeClass ( ExtensionManager ext)
static

◆ instance()

RootItem * RootItem::instance ( )
static

◆ mainInstance()

static RootItem* cnoid::RootItem::mainInstance ( )
inlinestatic

◆ numCheckEntries()

int RootItem::numCheckEntries ( ) const

◆ releaseCheckEntry()

void RootItem::releaseCheckEntry ( int  checkId)

◆ restore()

bool RootItem::restore ( const Archive archive)
overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ restoreCheckStates()

bool RootItem::restoreCheckStates ( int  checkId,
const Archive archive,
const std::string &  key 
)

◆ selectedItems() [1/2]

template<class ItemType >
ItemList<ItemType> cnoid::RootItem::selectedItems ( )
inline

◆ selectedItems() [2/2]

const ItemList& cnoid::RootItem::selectedItems ( )
inline

◆ selectItem()

void RootItem::selectItem ( Item item)

◆ sigCheckEntryAdded()

SignalProxy< void(int checkId)> RootItem::sigCheckEntryAdded ( )

◆ sigCheckEntryReleased()

SignalProxy< void(int checkId)> RootItem::sigCheckEntryReleased ( )

◆ sigCheckToggled()

SignalProxy< void(Item *item, bool on)> RootItem::sigCheckToggled ( int  checkId = PrimaryCheck)

◆ 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 ( )

◆ sigItemNameChanged()

SignalProxy< void(Item *item, const std::string &oldName)> RootItem::sigItemNameChanged ( )

◆ sigSelectedItemsChanged()

SignalProxy< void(const ItemList<> &selectedItems)> RootItem::sigSelectedItemsChanged ( )

◆ sigSelectionChanged()

SignalProxy< void(Item *item, bool on)> RootItem::sigSelectionChanged ( )

◆ sigSubTreeAdded()

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

◆ sigSubTreeMoved()

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

◆ sigSubTreeRemoved()

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

The signal that is emitted when an item belonging to the item tree from the root item is removed.

Parameters
isMovingIt is true if the item is moving and again belongs to the path from the root item.

◆ sigSubTreeRemoving()

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

The signal that is emitted just before an item belonging to the path from the root item is being removed.

Parameters
isMovingIt is true if the item is moving and again belongs to the path from the root item.

◆ sigTreeChanged()

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

◆ store()

bool RootItem::store ( Archive archive)
overrideprotectedvirtual

Reimplemented from cnoid::Item.

◆ storeCheckStates()

bool RootItem::storeCheckStates ( int  checkId,
Archive archive,
const std::string &  key 
)

Friends And Related Function Documentation

◆ Item

friend class Item
friend

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