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

#include <SubSimulatorItem.h>

Inheritance diagram for cnoid::SubSimulatorItem:
cnoid::Item cnoid::Referenced cnoid::GLVisionSimulatorItem

Public Member Functions

 SubSimulatorItem ()
 
 SubSimulatorItem (const SubSimulatorItem &org)
 
virtual bool isEnabled ()
 
virtual bool setEnabled (bool on)
 
virtual bool initializeSimulation (SimulatorItem *simulatorItem)
 
virtual void finalizeSimulation ()
 
- 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 void doPutProperties (PutPropertyFunction &putProperty)
 
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 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
 

Additional Inherited Members

- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 
- Static Public Member Functions inherited from cnoid::Item
static Itemfind (const std::string &path)
 
static SignalProxy< void(const char *type_info_name)> sigClassUnregistered ()
 

Constructor & Destructor Documentation

◆ SubSimulatorItem() [1/2]

SubSimulatorItem::SubSimulatorItem ( )

◆ SubSimulatorItem() [2/2]

SubSimulatorItem::SubSimulatorItem ( const SubSimulatorItem org)

Member Function Documentation

◆ doPutProperties()

void SubSimulatorItem::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::GLVisionSimulatorItem.

◆ finalizeSimulation()

void SubSimulatorItem::finalizeSimulation ( )
virtual

Reimplemented in cnoid::GLVisionSimulatorItem.

◆ initializeSimulation()

bool SubSimulatorItem::initializeSimulation ( SimulatorItem simulatorItem)
virtual

Reimplemented in cnoid::GLVisionSimulatorItem.

◆ isEnabled()

bool SubSimulatorItem::isEnabled ( )
virtual

◆ restore()

bool SubSimulatorItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

Reimplemented in cnoid::GLVisionSimulatorItem.

◆ setEnabled()

bool SubSimulatorItem::setEnabled ( bool  on)
virtual

◆ store()

bool SubSimulatorItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

Reimplemented in cnoid::GLVisionSimulatorItem.


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