Choreonoid  1.5
Public Types | Public Member Functions | List of all members
cnoid::RangeSensor Class Reference

#include <RangeSensor.h>

Inheritance diagram for cnoid::RangeSensor:
cnoid::Device cnoid::DeviceState cnoid::Referenced

Public Types

typedef std::vector< double > RangeData
 

Public Member Functions

 RangeSensor ()
 
 RangeSensor (const RangeSensor &org, bool copyStateOnly=false)
 
virtual const char * typeName ()
 
void copyStateFrom (const RangeSensor &other)
 
virtual void copyStateFrom (const DeviceState &other)
 
virtual DeviceStatecloneState () const
 
virtual Deviceclone () const
 
virtual void forEachActualType (boost::function< bool(const std::type_info &type)> func)
 
virtual void clearState ()
 
virtual int stateSize () const
 
virtual const double * readState (const double *buf)
 
virtual double * writeState (double *out_buf) const
 
bool on () const
 
void on (bool on)
 
double yawRange () const
 
void setYawRange (double angle)
 
int yawResolution () const
 
void setYawResolution (int n)
 
double yawStep () const
 
double pitchRange () const
 
void setPitchRange (double angle)
 
int pitchResolution () const
 
void setPitchResolution (double n)
 
double pitchStep () const
 
double maxDistance () const
 
void setMaxDistance (double d)
 
double minDistance () const
 
void setMinDistance (double d)
 
double frameRate () const
 
void setFrameRate (double r)
 
void setRangeDataStateClonable (bool on)
 
bool isRangeDataStateClonable () const
 
const RangeDatarangeData () const
 
const RangeDataconstRangeData () const
 
RangeDatarangeData ()
 
RangeDatanewRangeData ()
 
boost::shared_ptr< RangeDatasharedRangeData () const
 
void setRangeData (boost::shared_ptr< RangeData > &rangeData)
 
double delay () const
 
void setDelay (double time)
 
- Public Member Functions inherited from cnoid::Device
virtual ~Device ()
 
void setIndex (int index)
 
void setId (int id)
 
void setName (const std::string &name)
 
void setLink (Link *link)
 
bool hasStateOnly () const
 
const int index () const
 
const int id () const
 
const std::string & name () const
 
const Linklink () const
 
Linklink ()
 
Isometry3T_local ()
 
const Isometry3T_local () const
 
Isometry3::ConstLinearPart R_local () const
 
Isometry3::LinearPart R_local ()
 
Isometry3::ConstLinearPart localRotation () const
 
Isometry3::LinearPart localRotaion ()
 
template<typename Derived >
void setLocalRotation (const Eigen::MatrixBase< Derived > &R)
 
Isometry3::ConstTranslationPart p_local () const
 
Isometry3::TranslationPart p_local ()
 
Isometry3::ConstTranslationPart localTranslation () const
 
Isometry3::TranslationPart localTranslation ()
 
template<typename Derived >
void setLocalTranslation (const Eigen::MatrixBase< Derived > &p)
 
double cycle () const
 
void setCycle (double msec)
 
SignalProxy< void()> sigStateChanged ()
 
void notifyStateChange ()
 
- Public Member Functions inherited from cnoid::DeviceState
virtual ~DeviceState ()
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 
void addRef ()
 
void releaseRef ()
 

Additional Inherited Members

- Protected Member Functions inherited from cnoid::Device
 Device ()
 
 Device (const Device &org, bool copyStateOnly=false)
 
- Protected Member Functions inherited from cnoid::DeviceState
 DeviceState ()
 
 DeviceState (const DeviceState &org)
 
- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 

Member Typedef Documentation

◆ RangeData

typedef std::vector<double> cnoid::RangeSensor::RangeData

Constructor & Destructor Documentation

◆ RangeSensor() [1/2]

RangeSensor::RangeSensor ( )

◆ RangeSensor() [2/2]

RangeSensor::RangeSensor ( const RangeSensor org,
bool  copyStateOnly = false 
)

Member Function Documentation

◆ clearState()

void RangeSensor::clearState ( )
virtual

Reimplemented from cnoid::Device.

◆ clone()

Device * RangeSensor::clone ( ) const
virtual

Implements cnoid::Device.

◆ cloneState()

DeviceState * RangeSensor::cloneState ( ) const
virtual

Implements cnoid::DeviceState.

◆ constRangeData()

const RangeData& cnoid::RangeSensor::constRangeData ( ) const
inline

◆ copyStateFrom() [1/2]

void RangeSensor::copyStateFrom ( const RangeSensor other)

◆ copyStateFrom() [2/2]

void RangeSensor::copyStateFrom ( const DeviceState other)
virtual

Implements cnoid::DeviceState.

◆ delay()

double cnoid::RangeSensor::delay ( ) const
inline

Time [s] consumed in the measurement

◆ forEachActualType()

void RangeSensor::forEachActualType ( boost::function< bool(const std::type_info &type)>  func)
virtual

Reimplemented from cnoid::Device.

◆ frameRate()

double cnoid::RangeSensor::frameRate ( ) const
inline

◆ isRangeDataStateClonable()

bool cnoid::RangeSensor::isRangeDataStateClonable ( ) const
inline

◆ maxDistance()

double cnoid::RangeSensor::maxDistance ( ) const
inline

◆ minDistance()

double cnoid::RangeSensor::minDistance ( ) const
inline

◆ newRangeData()

RangeSensor::RangeData & RangeSensor::newRangeData ( )

◆ on() [1/2]

bool cnoid::RangeSensor::on ( ) const
inline

◆ on() [2/2]

void cnoid::RangeSensor::on ( bool  on)
inline

◆ pitchRange()

double cnoid::RangeSensor::pitchRange ( ) const
inline

◆ pitchResolution()

int cnoid::RangeSensor::pitchResolution ( ) const
inline

◆ pitchStep()

double RangeSensor::pitchStep ( ) const

◆ rangeData() [1/2]

const RangeData& cnoid::RangeSensor::rangeData ( ) const
inline
Note
You must check if the range data is not empty before accessing the data

◆ rangeData() [2/2]

RangeSensor::RangeData & RangeSensor::rangeData ( )

◆ readState()

const double * RangeSensor::readState ( const double *  buf)
virtual
Returns
The position in the buf after reading. The value is used when the super class's readState is called by the inherited class.

Implements cnoid::DeviceState.

◆ setDelay()

void cnoid::RangeSensor::setDelay ( double  time)
inline

◆ setFrameRate()

void RangeSensor::setFrameRate ( double  r)

◆ setMaxDistance()

void RangeSensor::setMaxDistance ( double  d)

◆ setMinDistance()

void RangeSensor::setMinDistance ( double  d)

◆ setPitchRange()

void RangeSensor::setPitchRange ( double  angle)

◆ setPitchResolution()

void RangeSensor::setPitchResolution ( double  n)

◆ setRangeData()

void RangeSensor::setRangeData ( boost::shared_ptr< RangeData > &  rangeData)

Move semantics. If the use_count() of the given shared range data pointer is one, the data is moved to the Camera object and the ownership of the given pointer is released. Otherwise, the data is copied.

◆ setRangeDataStateClonable()

void cnoid::RangeSensor::setRangeDataStateClonable ( bool  on)
inline

◆ setYawRange()

void RangeSensor::setYawRange ( double  angle)

◆ setYawResolution()

void RangeSensor::setYawResolution ( int  n)

◆ sharedRangeData()

boost::shared_ptr<RangeData> cnoid::RangeSensor::sharedRangeData ( ) const
inline

◆ stateSize()

int RangeSensor::stateSize ( ) const
virtual

Size of the double-precision floating numbers for representing the state.

Implements cnoid::DeviceState.

◆ typeName()

const char * RangeSensor::typeName ( )
virtual

Implements cnoid::DeviceState.

◆ writeState()

double * RangeSensor::writeState ( double *  out_buf) const
virtual
Returns
The position in the buf after reading. The value is used when the super class's readState is called by the inherited class.

Implements cnoid::DeviceState.

◆ yawRange()

double cnoid::RangeSensor::yawRange ( ) const
inline

◆ yawResolution()

int cnoid::RangeSensor::yawResolution ( ) const
inline

◆ yawStep()

double RangeSensor::yawStep ( ) const

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