scl::SSensorBase Class Reference

#include <CSensorBase.hpp>

Inheritance diagram for scl::SSensorBase:

Collaboration diagram for scl::SSensorBase:

Public Member Functions
virtual const std::string &	getType () const
virtual const std::string &	getName () const
virtual bool	hasBeenInit () const

Public Attributes
sBool	flag_apply_temporal_limits_
sBool	flag_apply_temporal_jitter_
sBool	flag_apply_temporal_delay_
sBool	flag_apply_spatial_limits_
sBool	flag_apply_noise_
std::string	name_
sBool	has_been_init_

Protected Attributes
std::string	type_

Detailed Description

Some defaults that allow controlling a sensor model's behavior. All sensor models should support these.

NOTE : Please don't be confused. This is an actuator "model", and as these flags make sense for a simulated actuator. It is "NOT" meant as an interface to a real actuator.

Member Function Documentation

virtual const std::string& scl::SObject::getName ( ) const

inlinevirtualinherited

Get the object's type

virtual const std::string& scl::SObject::getType ( ) const

inlinevirtualinherited

Get the object's type

virtual bool scl::SObject::hasBeenInit ( ) const

inlinevirtualinherited

Get the object's type

Member Data Documentation

sBool scl::SSensorBase::flag_apply_noise_

A sensor may have a noise model to simulate the real world. Setting this flag will enable it.

DEFAULT : true

sBool scl::SSensorBase::flag_apply_spatial_limits_

This applies any spatial sampling limits to the sensor. In simulation, an encoder or a camera might have potentially infinite resolution. Setting this flag will force sampling the sensor at its actual spatial precision. Eg. Discretize encoder values, Fix video resolution to 640x480 etc.

DEFAULT : true

sBool scl::SSensorBase::flag_apply_temporal_delay_

This applies any real-time constant lag at the sensor. In simulation, an encoder or a camera can instantaneously sample the physical world. Setting this flag will force some constant temporal lag in the sensor. Ie. The sampled state will be stale. Eg. Line delay from an encoder to the computer

DEFAULT : true

sBool scl::SSensorBase::flag_apply_temporal_jitter_

This applies any real-time jitter limits to the sensor. In simulation, an encoder or a camera can instantaneously sample the physical world. Setting this flag will force some temporal jitter in the sensor. Ie. The sampled state could be stale. Eg. Sample encoder at 1ms

DEFAULT : true

sBool scl::SSensorBase::flag_apply_temporal_limits_

This applies any temporal sampling limits to the sensor. In simulation, an encoder or a camera might have potentially infinite resolution. Setting this flag will force sampling the sensor at its actual temporal precision. Eg. Sample encoder at 1ms

DEFAULT : true

sBool scl::SObject::has_been_init_

inherited

Whether the object is ready for use

std::string scl::SObject::name_

inherited

The object's name

std::string scl::SObject::type_

protectedinherited

The object's type. Should only be set by the constructor

---

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

• /home/samir/Code/control/scl.git/src/scl/sensing/CSensorBase.hpp