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

#include <RTCItem.h>

Inheritance diagram for cnoid::RTCItem:
cnoid::Item cnoid::Referenced

Public Types

enum  PERIODIC_TYPE {
  PERIODIC_EXECUTION_CONTEXT = 0, SYNCH_EXT_TRIGGER, EXT_TRIG_EXECUTION_CONTEXT, CHOREONOID_EXECUTION_CONTEXT,
  N_PERIODIC_TYPE
}
 
enum  PathBase { RTC_DIRECTORY = 0, PROJECT_DIRECTORY, N_PATH_BASE }
 
- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 

Public Member Functions

 RTCItem ()
 
 RTCItem (const RTCItem &org)
 
virtual ~RTCItem ()
 
void setModuleName (const std::string &name)
 
void setPeriodicType (int type)
 
void setPeriodicRate (int rate)
 
void setPathBase (int base)
 
- 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 initialize (ExtensionManager *ext)
 
- 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 void onPositionChanged ()
 
virtual void onDisconnectedFromRoot ()
 
virtual ItemdoDuplicate () const
 
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 bool onChildItemAboutToBeAdded (Item *childItem, bool isManualOperation)
 
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
 

Member Enumeration Documentation

Enumerator
RTC_DIRECTORY 
PROJECT_DIRECTORY 
N_PATH_BASE 
Enumerator
PERIODIC_EXECUTION_CONTEXT 
SYNCH_EXT_TRIGGER 
EXT_TRIG_EXECUTION_CONTEXT 
CHOREONOID_EXECUTION_CONTEXT 
N_PERIODIC_TYPE 

Constructor & Destructor Documentation

RTCItem::RTCItem ( )
RTCItem::RTCItem ( const RTCItem org)
RTCItem::~RTCItem ( )
virtual

Member Function Documentation

Item * RTCItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

void RTCItem::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.

void RTCItem::initialize ( ExtensionManager ext)
static
void RTCItem::onDisconnectedFromRoot ( )
protectedvirtual

Reimplemented from cnoid::Item.

void RTCItem::onPositionChanged ( )
protectedvirtual

Reimplemented from cnoid::Item.

bool RTCItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

void RTCItem::setModuleName ( const std::string &  name)
void RTCItem::setPathBase ( int  base)
void RTCItem::setPeriodicRate ( int  rate)
void RTCItem::setPeriodicType ( int  type)
bool RTCItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.


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