AGX Dynamics 2.42.1.1
Loading...
Searching...
No Matches
agxSensor::LidarModel Class Reference

Base lidar model describing the fundamentals, such as ray pattern, range and beam properties, of a lidar. More...

#include <LidarModel.h>

+ Inheritance diagram for agxSensor::LidarModel:

Public Member Functions

 LidarModel (LidarRayPatternGenerator *rayPatternGenerator, agx::RangeReal32 range, LidarProperties *properties=nullptr, RtOutputNoiseRefVector outputNoises=RtOutputNoiseRefVector())
 Construct given ray pattern generator, range and (optional) properties.
 
const RtOutputNoiseRefVectorgetOutputNoises () const
 
LidarPropertiesgetProperties () const
 
LidarRayPatternGeneratorgetRayPatternGenerator () const
 
LidarRayRangegetRayRange () const
 
bool isValid (bool printIssues=true) const
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referencedoperator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandlergetDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Base lidar model describing the fundamentals, such as ray pattern, range and beam properties, of a lidar.

Definition at line 35 of file LidarModel.h.

Constructor & Destructor Documentation

◆ LidarModel()

agxSensor::LidarModel::LidarModel ( LidarRayPatternGenerator rayPatternGenerator,
agx::RangeReal32  range,
LidarProperties properties = nullptr,
RtOutputNoiseRefVector  outputNoises = RtOutputNoiseRefVector() 
)

Construct given ray pattern generator, range and (optional) properties.

If properties is nullptr, new, default properties is created.

Parameters
rayPatternGenerator- specific ray pattern generator of this lidar model, invalid if nullptr
range- defines minimum and maximum range of this lidar model
properties- properties/parameters of this model
outputNoises- list of noise output modifications

Member Function Documentation

◆ getOutputNoises()

const RtOutputNoiseRefVector & agxSensor::LidarModel::getOutputNoises ( ) const
Returns
vector of output noises of this lidar model

◆ getProperties()

LidarProperties * agxSensor::LidarModel::getProperties ( ) const
Returns
the properties/parameters of this lidar model

◆ getRayPatternGenerator()

LidarRayPatternGenerator * agxSensor::LidarModel::getRayPatternGenerator ( ) const
Returns
the ray pattern generator of this lidar model

◆ getRayRange()

LidarRayRange * agxSensor::LidarModel::getRayRange ( ) const
Returns
the ray range of this lidar model

◆ isValid()

bool agxSensor::LidarModel::isValid ( bool  printIssues = true) const
Parameters
printIssues- true to log warning if there are issues, false to be silent
Returns
true if the lidar model has all components required to simulate a lidar

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