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

#include <BodyRTCItem.h>

Inheritance diagram for cnoid::BodyRTCItem:
cnoid::ControllerItem cnoid::Item cnoid::Referenced

Public Types

enum  ConfigMode { CONF_FILE_MODE = 0, CONF_ALL_MODE, N_CONFIG_MODES }
 
enum  PathBase { RTC_DIRECTORY = 0, PROJECT_DIRECTORY, N_PATH_BASE }
 
- Public Types inherited from cnoid::ControllerItem
typedef ControllerItemIO Target
 
- Public Types inherited from cnoid::Item
enum  Attribute { SUB_ITEM, TEMPORAL, LOAD_ONLY, NUM_ATTRIBUTES }
 

Public Member Functions

 BodyRTCItem ()
 
 BodyRTCItem (const BodyRTCItem &org)
 
virtual ~BodyRTCItem ()
 
virtual bool start (ControllerItemIO *io)
 
virtual double timeStep () const
 
virtual void input ()
 
virtual bool control ()
 
virtual void output ()
 
virtual void stop ()
 
const BodyPtrbody () const
 
const DeviceList< ForceSensor > & forceSensors () const
 
const DeviceList< RateGyroSensor > & rateGyroSensors () const
 
const DeviceList< AccelerationSensor > & accelerationSensors () const
 
double controlTime () const
 
void setControllerModule (const std::string &name)
 
void setConfigFile (const std::string &filename)
 
void setConfigMode (int mode)
 
void setPeriodicRate (double freq)
 
void setAutoConnectionMode (bool on)
 
void setPathBase (int pathBase)
 
- Public Member Functions inherited from cnoid::ControllerItem
 ControllerItem ()
 
 ControllerItem (const ControllerItem &org)
 
virtual ~ControllerItem ()
 
bool isActive () const
 
bool isImmediateMode () const
 
void setImmediateMode (bool on)
 
const std::string & optionString () const
 
bool splitOptionString (const std::string &optionString, std::vector< std::string > &out_options) const
 
virtual bool initialize (ControllerItemIO *io)
 
virtual bool start ()
 
SignalProxy< void(const std::string &message)> sigMessage ()
 
std::string getMessage ()
 
- 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::ControllerItem
void putMessage (const std::string &message)
 
- 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
CONF_FILE_MODE 
CONF_ALL_MODE 
N_CONFIG_MODES 
Enumerator
RTC_DIRECTORY 
PROJECT_DIRECTORY 
N_PATH_BASE 

Constructor & Destructor Documentation

BodyRTCItem::BodyRTCItem ( )
BodyRTCItem::BodyRTCItem ( const BodyRTCItem org)
BodyRTCItem::~BodyRTCItem ( )
virtual

Member Function Documentation

const DeviceList<AccelerationSensor>& cnoid::BodyRTCItem::accelerationSensors ( ) const
inline
const BodyPtr& cnoid::BodyRTCItem::body ( ) const
inline
bool BodyRTCItem::control ( )
virtual

Implements cnoid::ControllerItem.

double cnoid::BodyRTCItem::controlTime ( ) const
inline
Item * BodyRTCItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

void BodyRTCItem::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::ControllerItem.

const DeviceList<ForceSensor>& cnoid::BodyRTCItem::forceSensors ( ) const
inline
void BodyRTCItem::initialize ( ExtensionManager ext)
static
void BodyRTCItem::input ( )
virtual
Note
This function is called from the simulation thread.

Implements cnoid::ControllerItem.

void BodyRTCItem::onDisconnectedFromRoot ( )
protectedvirtual

Reimplemented from cnoid::Item.

void BodyRTCItem::onPositionChanged ( )
protectedvirtual

Reimplemented from cnoid::Item.

void BodyRTCItem::output ( )
virtual
Note
This function is called from the simulation thread.

Implements cnoid::ControllerItem.

const DeviceList<RateGyroSensor>& cnoid::BodyRTCItem::rateGyroSensors ( ) const
inline
bool BodyRTCItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::ControllerItem.

void BodyRTCItem::setAutoConnectionMode ( bool  on)
void BodyRTCItem::setConfigFile ( const std::string &  filename)
void BodyRTCItem::setConfigMode ( int  mode)
void BodyRTCItem::setControllerModule ( const std::string &  name)
void BodyRTCItem::setPathBase ( int  pathBase)
void BodyRTCItem::setPeriodicRate ( double  freq)
bool BodyRTCItem::start ( ControllerItemIO io)
virtual
Deprecated:

Reimplemented from cnoid::ControllerItem.

void BodyRTCItem::stop ( )
virtual
Note
This function is called from the main thread.

Reimplemented from cnoid::ControllerItem.

bool BodyRTCItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::ControllerItem.

double BodyRTCItem::timeStep ( void  ) const
virtual

Implements cnoid::ControllerItem.


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