#include <Os/DelegateRawTime.hpp>

Inheritance diagram for Os::DelegateRawTime:

Public Member Functions
	DelegateRawTime ()
	Default constructor. More...

	DelegateRawTime (RawTimeSource source)
	Constructor with timer source selection. More...

	~DelegateRawTime () final
	Destructor. More...

	DelegateRawTime (const DelegateRawTime &other)
	copy constructor that copies the internal representation More...

DelegateRawTime &	operator= (const DelegateRawTime &other)
	assignment operator that copies the internal representation More...

RawTimeHandle *	getHandle () override
	return the underlying RawTime handle (implementation specific) More...

Status	now () override
	Get the current time. More...

Status	getTimeInterval (const Os::RawTime &other, Fw::TimeInterval &interval) const override
	Calculate the time interval between this and another raw time. More...

Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const override
	Serialize the contents of the RawTimeInterface object into a buffer. More...

Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) override
	Deserialize the contents of the RawTimeInterface object from a buffer. More...

Status	getDiffUsec (const RawTime &other, U32 &result) const override
	Calculate the difference in microseconds between two RawTime objects. More...

bool	operator== (const RawTime &other) const override
	Compare whether two RawTime objects are the same (i.e. refer to the same microsecond) More...

RawTimeSource	getSource () const
	Get the timer source used by this RawTime instance. More...

Public Member Functions inherited from Os::RawTimeInterface
	RawTimeInterface ()=default
	default constructor More...

virtual	~RawTimeInterface ()=default
	default virtual destructor More...

Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")

	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Additional Inherited Members
Public Types inherited from Os::RawTimeInterface
enum	Status { OP_OK, OP_OVERFLOW, INVALID_PARAMS, NOT_SUPPORTED, OTHER_ERROR }

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Static Public Member Functions inherited from Os::RawTimeInterface
static RawTimeInterface *	getDelegate (RawTimeHandleStorage &aligned_new_memory, const RawTimeInterface *to_copy=nullptr, RawTimeSource source=RAWTIME_DEFAULT)
	provide a pointer to a RawTime delegate object More...

Static Public Attributes inherited from Os::RawTimeInterface
static const FwSizeType	SERIALIZED_SIZE = FW_RAW_TIME_SERIALIZATION_MAX_SIZE

Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...

virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Definition at line 12 of file DelegateRawTime.hpp.

Constructor & Destructor Documentation

◆ DelegateRawTime() [1/3]

Os::DelegateRawTime::DelegateRawTime ( )

Default constructor.

Definition at line 11 of file DelegateRawTime.cpp.

◆ DelegateRawTime() [2/3]

Os::DelegateRawTime::DelegateRawTime ( RawTimeSource source )

explicit

Constructor with timer source selection.

Parameters

source Timer source to use (defaults to RAWTIME_DEFAULT)

Definition at line 15 of file DelegateRawTime.cpp.

◆ ~DelegateRawTime()

Os::DelegateRawTime::~DelegateRawTime ( )

final

Destructor.

Definition at line 20 of file DelegateRawTime.cpp.

◆ DelegateRawTime() [3/3]

Os::DelegateRawTime::DelegateRawTime ( const DelegateRawTime & other )

copy constructor that copies the internal representation

Definition at line 27 of file DelegateRawTime.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Os::DelegateRawTime::deserializeFrom	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)

overridevirtual

Deserialize the contents of the RawTimeInterface object from a buffer.

This function deserializes the contents of the RawTimeInterface object from the provided buffer.

Note: The serialization must fit within FW_RAW_TIME_SERIALIZATION_MAX_SIZE bytes. This value is defined in FpConfig.h. For example, Posix systems use a pair of U32 (sec, nanosec) and can therefore serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase that value in its config/ folder.

Parameters

buffer	The buffer to deserialize the contents from.
mode	Endianness to use when deserializing from the buffer.

Returns: Fw::SerializeStatus indicating the result of the deserialization.

Implements Os::RawTimeInterface.

Definition at line 61 of file DelegateRawTime.cpp.

◆ getDiffUsec()

DelegateRawTime::Status Os::DelegateRawTime::getDiffUsec	(	const RawTime &	other,
		U32 &	result
	)		const

overridevirtual

Calculate the difference in microseconds between two RawTime objects.

This function calculates the difference in microseconds between the current RawTime object and another RawTime object provided as a parameter.

Warning: This function will return Status::OP_OVERFLOW if the time difference is too large to fit in a U32.; This means the largest time difference that can be measured is 2^32 microseconds (about 71 minutes).; Users should prefer getTimeInterval() for larger intervals.

Parameters

other	The other RawTime object to compare against.
result	A reference to a U32 variable where the result will be stored.

Returns: Status indicating the result of the operation.

Reimplemented from Os::RawTimeInterface.

Definition at line 66 of file DelegateRawTime.cpp.

◆ getHandle()

RawTimeHandle * Os::DelegateRawTime::getHandle ( )

overridevirtual

return the underlying RawTime handle (implementation specific)

Returns: internal RawTime handle representation

Implements Os::RawTimeInterface.

Definition at line 41 of file DelegateRawTime.cpp.

◆ getSource()

RawTimeSource Os::DelegateRawTime::getSource ( ) const

Get the timer source used by this RawTime instance.

Returns: The RawTimeSource value configured for this instance

Definition at line 76 of file DelegateRawTime.cpp.

◆ getTimeInterval()

DelegateRawTime::Status Os::DelegateRawTime::getTimeInterval	(	const Os::RawTime &	other,
		Fw::TimeInterval &	interval
	)		const

overridevirtual

Calculate the time interval between this and another raw time.

This function calculates the time interval between the current raw time and another specified raw time. The result is stored in the provided (output) interval object.

Parameters

other	The other RawTimeHandle to compare against.
interval	Output parameter to store the calculated time interval.

Returns: Status indicating the result of the operation.

Implements Os::RawTimeInterface.

Definition at line 51 of file DelegateRawTime.cpp.

◆ now()

DelegateRawTime::Status Os::DelegateRawTime::now ( )

overridevirtual

Get the current time.

This function retrieves the current time and stores it in the RawTime object. Each implementation should define its RawTimeHandle type for storing the time.

Returns: Status indicating the result of the operation.

Implements Os::RawTimeInterface.

Definition at line 46 of file DelegateRawTime.cpp.

◆ operator=()

DelegateRawTime & Os::DelegateRawTime::operator= ( const DelegateRawTime & other )

assignment operator that copies the internal representation

Definition at line 33 of file DelegateRawTime.cpp.

◆ operator==()

bool Os::DelegateRawTime::operator== ( const RawTime & other ) const

overridevirtual

Compare whether two RawTime objects are the same (i.e. refer to the same microsecond)

Reimplemented from Os::RawTimeInterface.

Definition at line 71 of file DelegateRawTime.cpp.

◆ serializeTo()

Fw::SerializeStatus Os::DelegateRawTime::serializeTo	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)		const

overridevirtual

Serialize the contents of the RawTimeInterface object into a buffer.

This function serializes the contents of the RawTimeInterface object into the provided buffer.

Note: The serialization must fit within FW_RAW_TIME_SERIALIZATION_MAX_SIZE bytes. This value is defined in FpConfig.h. For example, Posix systems use a pair of U32 (sec, nanosec) and can therefore serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase that value in its config/ folder.

Parameters

buffer	The buffer to serialize the contents into.
mode	Endianness to use when serializing to buffer.

Returns: Fw::SerializeStatus indicating the result of the serialization.

Implements Os::RawTimeInterface.

Definition at line 56 of file DelegateRawTime.cpp.

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

Os/DelegateRawTime.hpp
Os/DelegateRawTime.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DelegateRawTime() [1/3]

◆ DelegateRawTime() [2/3]

◆ ~DelegateRawTime()

◆ DelegateRawTime() [3/3]

Member Function Documentation

◆ deserializeFrom()

◆ getDiffUsec()

◆ getHandle()

◆ getSource()

◆ getTimeInterval()

◆ now()

◆ operator=()

◆ operator==()

◆ serializeTo()