serial::Response Class Reference

Manages radar signal responses from a transmitter. More...

#include "response.h"

Public Member Functions
	Response (const fers_signal::RadarSignal *wave, const radar::Transmitter *transmitter) noexcept
	Constructor for the Response class.
	~Response ()=default
	Response (const Response &)=delete
Response &	operator= (const Response &)=delete
	Response (Response &&)=delete
Response &	operator= (Response &&)=delete
RealType	startTime () const noexcept
	Retrieves the start time of the response.
RealType	endTime () const noexcept
	Retrieves the end time of the response.
void	addInterpPoint (const interp::InterpPoint &point)
	Adds an interpolation point to the response.
std::vector< ComplexType >	renderBinary (RealType &rate, unsigned &size, RealType fracWinDelay) const
	Renders the response in binary format.
RealType	getLength () const noexcept
	Retrieves the length of the response.
std::string	getTransmitterName () const noexcept
	Retrieves the name of the associated transmitter.

Detailed Description

Manages radar signal responses from a transmitter.

Definition at line 39 of file response.h.

Constructor & Destructor Documentation

Response() [1/3]

serial::Response::Response ( const fers_signal::RadarSignal *  wave, const radar::Transmitter *  transmitter  )

noexcept

Constructor for the Response class.

Parameters

wave	Pointer to the radar signal object.
transmitter	Pointer to the transmitter object.

Definition at line 48 of file response.h.

                                                                                                   :
            _transmitter(transmitter), _wave(wave)
        {
        }

~Response()

serial::Response::~Response ( )

default

Response() [2/3]

serial::Response::Response ( const Response &  )

delete

Response() [3/3]

serial::Response::Response ( Response &&  )

delete

Member Function Documentation

addInterpPoint()

void serial::Response::addInterpPoint

(

const interp::InterpPoint &

point

)

Adds an interpolation point to the response.

Parameters

point

The interpolation point to be added.

Exceptions

std::logic_error

If the new point has a time earlier than the last point.

Definition at line 26 of file response.cpp.

{ _points.push_back(point); }

endTime()

RealType serial::Response::endTime ( ) const

noexcept

Retrieves the end time of the response.

Returns

End time as a RealType. Returns 0.0 if no points are present.

Definition at line 71 of file response.h.

{ return _points.empty() ? 0.0 : _points.back().time; }

Referenced by getLength().

Here is the caller graph for this function:

getLength()

RealType serial::Response::getLength ( ) const

noexcept

Retrieves the length of the response.

Returns

The length of the response as a RealType.

Definition at line 96 of file response.h.

{ return endTime() - startTime(); }

References endTime(), and startTime().

Here is the call graph for this function:

getTransmitterName()

std::string serial::Response::getTransmitterName ( ) const

noexcept

Retrieves the name of the associated transmitter.

Returns

The name of the transmitter as a std::string.

Definition at line 24 of file response.cpp.

{ return _transmitter->getName(); }

References radar::Object::getName().

Here is the call graph for this function:

operator=() [1/2]

Response & serial::Response::operator= ( const Response &  )

delete

operator=() [2/2]

Response & serial::Response::operator= ( Response &&  )

delete

renderBinary()

std::vector< ComplexType > serial::Response::renderBinary	(	RealType &	rate,
		unsigned &	size,
		RealType	fracWinDelay
	)		const

Renders the response in binary format.

Parameters

rate	Output parameter for the signal rate.
size	Output parameter for the size of the binary data.
fracWinDelay	Delay factor applied during windowing.

Returns

A vector of ComplexType representing the binary data.

Definition at line 28 of file response.cpp.

    {
        rate = _wave->getRate();
        return _wave->render(_points, size, fracWinDelay);
    }

References fers_signal::RadarSignal::getRate(), and fers_signal::RadarSignal::render().

Here is the call graph for this function:

startTime()

RealType serial::Response::startTime ( ) const

noexcept

Retrieves the start time of the response.

Returns

Start time as a RealType. Returns 0.0 if no points are present.

Definition at line 64 of file response.h.

{ return _points.empty() ? 0.0 : _points.front().time; }

Referenced by getLength().

Here is the caller graph for this function:

---

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

• packages/libfers/src/serial/response.h
• packages/libfers/src/serial/response.cpp