F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::TimeBasePair Class Reference

#include <Svc/Ports/TimeConverterPorts/TimeBasePairSerializableAc.hpp>

Inheritance diagram for Svc::TimeBasePair:
Fw::Serializable

Public Types

enum  { SERIALIZED_SIZE }
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 TimeBasePair ()
 Constructor (default value) More...
 
 TimeBasePair (TimeBase::T lower, TimeBase::T upper)
 Member constructor. More...
 
 TimeBasePair (const TimeBasePair &obj)
 Copy constructor. More...
 
TimeBasePair & operator= (const TimeBasePair &obj)
 Copy assignment operator. More...
 
bool operator== (const TimeBasePair &obj) const
 Equality operator. More...
 
bool operator!= (const TimeBasePair &obj) const
 Inequality operator. More...
 
Fw::SerializeStatus serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
 Serialization. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialization. More...
 
FwSizeType serializedSize () const
 Get the dynamic serialized size of the struct. More...
 
TimeBase::T get_lower () const
 Get member lower. More...
 
TimeBase::T get_upper () const
 Get member upper. More...
 
void set (TimeBase::T lower, TimeBase::T upper)
 Set all members. More...
 
void set_lower (TimeBase::T lower)
 Set member lower. More...
 
void set_upper (TimeBase::T upper)
 Set member upper. 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")
 

Protected Attributes

TimeBase m_lower
 
TimeBase m_upper
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 Virtual destructor. More...
 

Detailed Description

An unordered pair of time bases, held in canonical order so that a pair and its reverse produce the same value

Definition at line 20 of file TimeBasePairSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file TimeBasePairSerializableAc.hpp.

Constructor & Destructor Documentation

◆ TimeBasePair() [1/3]

Svc::TimeBasePair::TimeBasePair ( )

Constructor (default value)

Definition at line 17 of file TimeBasePairSerializableAc.cpp.

◆ TimeBasePair() [2/3]

Svc::TimeBasePair::TimeBasePair ( TimeBase::T  lower,
TimeBase::T  upper 
)

Member constructor.

Definition at line 26 of file TimeBasePairSerializableAc.cpp.

◆ TimeBasePair() [3/3]

Svc::TimeBasePair::TimeBasePair ( const TimeBasePair &  obj)

Copy constructor.

Parameters
objThe source object

Definition at line 38 of file TimeBasePairSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::TimeBasePair::deserializeFrom ( Fw::SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 113 of file TimeBasePairSerializableAc.cpp.

◆ get_lower()

TimeBase::T Svc::TimeBasePair::get_lower ( ) const
inline

Get member lower.

Definition at line 123 of file TimeBasePairSerializableAc.hpp.

◆ get_upper()

TimeBase::T Svc::TimeBasePair::get_upper ( ) const
inline

Get member upper.

Definition at line 129 of file TimeBasePairSerializableAc.hpp.

◆ operator!=()

bool Svc::TimeBasePair::operator!= ( const TimeBasePair &  obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 72 of file TimeBasePairSerializableAc.cpp.

◆ operator=()

TimeBasePair & Svc::TimeBasePair::operator= ( const TimeBasePair &  obj)

Copy assignment operator.

Parameters
objThe source object

Definition at line 51 of file TimeBasePairSerializableAc.cpp.

◆ operator==()

bool Svc::TimeBasePair::operator== ( const TimeBasePair &  obj) const

Equality operator.

Parameters
objThe other object

Definition at line 62 of file TimeBasePairSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::TimeBasePair::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 133 of file TimeBasePairSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::TimeBasePair::serializeTo ( Fw::SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
virtual

Serialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 93 of file TimeBasePairSerializableAc.cpp.

◆ set()

void Svc::TimeBasePair::set ( TimeBase::T  lower,
TimeBase::T  upper 
)

Set all members.

Definition at line 169 of file TimeBasePairSerializableAc.cpp.

◆ set_lower()

void Svc::TimeBasePair::set_lower ( TimeBase::T  lower)

Set member lower.

Definition at line 179 of file TimeBasePairSerializableAc.cpp.

◆ set_upper()

void Svc::TimeBasePair::set_upper ( TimeBase::T  upper)

Set member upper.

Definition at line 185 of file TimeBasePairSerializableAc.cpp.

Member Data Documentation

◆ m_lower

TimeBase Svc::TimeBasePair::m_lower
protected

Definition at line 156 of file TimeBasePairSerializableAc.hpp.

◆ m_upper

TimeBase Svc::TimeBasePair::m_upper
protected

Definition at line 157 of file TimeBasePairSerializableAc.hpp.


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