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

#include <WorldLogFileItem.h>

Inheritance diagram for cnoid::WorldLogFileItem:
cnoid::Item cnoid::Referenced

Public Member Functions

 WorldLogFileItem ()
 
 WorldLogFileItem (const WorldLogFileItem &org)
 
 ~WorldLogFileItem ()
 
bool setLogFileName (const std::string &filename)
 
const std::string & logFileName () const
 
double recordingFrameRate () const
 
void clearOutput ()
 
void beginHeaderOutput ()
 
int outputBodyHeader (const std::string &name)
 
void endHeaderOutput ()
 
void beginFrameOutput (double time)
 
void beginBodyStateOutput ()
 
void outputLinkPositions (SE3 *positions, int size)
 
void outputJointPositions (double *values, int size)
 
void beginDeviceStateOutput ()
 
void outputDeviceState (DeviceState *state)
 
void endDeviceStateOutput ()
 
void endBodyStateOutput ()
 
void endFrameOutput ()
 
int numBodies () const
 
const std::string & bodyName (int bodyIndex) const
 
bool recallStateAtTime (double time)
 
void invalidateLastStateConsistency ()
 
virtual void notifyUpdate ()
 
- 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)
 
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 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 void onPositionChanged ()
 
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 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
 

Additional Inherited Members

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

Constructor & Destructor Documentation

WorldLogFileItem::WorldLogFileItem ( )
WorldLogFileItem::WorldLogFileItem ( const WorldLogFileItem org)
WorldLogFileItem::~WorldLogFileItem ( )

Member Function Documentation

void WorldLogFileItem::beginBodyStateOutput ( )
void WorldLogFileItem::beginDeviceStateOutput ( )
void WorldLogFileItem::beginFrameOutput ( double  time)
void WorldLogFileItem::beginHeaderOutput ( )
const std::string & WorldLogFileItem::bodyName ( int  bodyIndex) const
void WorldLogFileItem::clearOutput ( )
Item * WorldLogFileItem::doDuplicate ( ) const
protectedvirtual

Override this function to allow duplication of an instance.

Reimplemented from cnoid::Item.

void WorldLogFileItem::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 WorldLogFileItem::endBodyStateOutput ( )
void WorldLogFileItem::endDeviceStateOutput ( )
void WorldLogFileItem::endFrameOutput ( )
void WorldLogFileItem::endHeaderOutput ( )
void WorldLogFileItem::initializeClass ( ExtensionManager ext)
static
void WorldLogFileItem::invalidateLastStateConsistency ( )
const std::string & WorldLogFileItem::logFileName ( ) const
void WorldLogFileItem::notifyUpdate ( )
virtual

Reimplemented from cnoid::Item.

int WorldLogFileItem::numBodies ( ) const
void WorldLogFileItem::onPositionChanged ( )
protectedvirtual

Reimplemented from cnoid::Item.

int WorldLogFileItem::outputBodyHeader ( const std::string &  name)
void WorldLogFileItem::outputDeviceState ( DeviceState state)
void WorldLogFileItem::outputJointPositions ( double *  values,
int  size 
)
void WorldLogFileItem::outputLinkPositions ( SE3 positions,
int  size 
)
bool WorldLogFileItem::recallStateAtTime ( double  time)
Returns
True if the time is within the data range and the frame is correctly recalled. False if the time is outside the data range or the frame cannot be recalled.
double WorldLogFileItem::recordingFrameRate ( ) const
bool WorldLogFileItem::restore ( const Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.

bool WorldLogFileItem::setLogFileName ( const std::string &  filename)
bool WorldLogFileItem::store ( Archive archive)
protectedvirtual

Reimplemented from cnoid::Item.


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