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

Parameter write error. More...

#include <Svc/PrmDb/PrmDb_PrmWriteErrorEnumAc.hpp>

Inheritance diagram for Svc::PrmDb_PrmWriteError:
Fw::Serializable

Public Types

enum  T {
  OPEN = 0, DELIMITER = 1, DELIMITER_SIZE = 2, RECORD_SIZE = 3,
  RECORD_SIZE_SIZE = 4, PARAMETER_ID = 5, PARAMETER_ID_SIZE = 6, PARAMETER_VALUE = 7,
  PARAMETER_VALUE_SIZE = 8, CRC_PLACE = 9, CRC_REAL = 10, CURR_POSITION = 11,
  SEEK_ZERO = 12, SEEK_POSITION = 13
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 14 }
 
typedef U8 SerialType
 The serial representation type. More...
 
typedef enum T t
 For backwards compatibility. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 PrmDb_PrmWriteError ()
 Constructor (default value of OPEN) More...
 
 PrmDb_PrmWriteError (const enum T e1)
 Constructor (user-provided value) More...
 
 PrmDb_PrmWriteError (const PrmDb_PrmWriteError &obj)
 Copy constructor. More...
 
PrmDb_PrmWriteErroroperator= (const PrmDb_PrmWriteError &obj)
 Copy assignment operator (object) More...
 
PrmDb_PrmWriteErroroperator= (enum T e1)
 Copy assignment operator (raw enum) More...
 
 operator enum T () const
 Conversion operator. More...
 
bool operator== (enum T e1) const
 Equality operator. More...
 
bool operator!= (enum T e1) const
 Inequality operator. More...
 
bool isValid () const
 Check raw enum value for validity. More...
 
Fw::SerializeStatus serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
 Serialize raw enum value to SerialType. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialize raw enum value from SerialType. 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")
 

Public Attributes

enum T e
 The raw enum value. More...
 

Additional Inherited Members

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

Detailed Description

Parameter write error.

Definition at line 17 of file PrmDb_PrmWriteErrorEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ t

For backwards compatibility.

Definition at line 49 of file PrmDb_PrmWriteErrorEnumAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

NUM_CONSTANTS 

The number of enumerated constants.

Definition at line 57 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ T

The raw enum type.

Enumerator
OPEN 
DELIMITER 
DELIMITER_SIZE 
RECORD_SIZE 
RECORD_SIZE_SIZE 
PARAMETER_ID 
PARAMETER_ID_SIZE 
PARAMETER_VALUE 
PARAMETER_VALUE_SIZE 
CRC_PLACE 
CRC_REAL 
CURR_POSITION 
SEEK_ZERO 
SEEK_POSITION 

Definition at line 31 of file PrmDb_PrmWriteErrorEnumAc.hpp.

Constructor & Destructor Documentation

◆ PrmDb_PrmWriteError() [1/3]

Svc::PrmDb_PrmWriteError::PrmDb_PrmWriteError ( )
inline

Constructor (default value of OPEN)

Definition at line 71 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ PrmDb_PrmWriteError() [2/3]

Svc::PrmDb_PrmWriteError::PrmDb_PrmWriteError ( const enum T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 77 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ PrmDb_PrmWriteError() [3/3]

Svc::PrmDb_PrmWriteError::PrmDb_PrmWriteError ( const PrmDb_PrmWriteError obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 85 of file PrmDb_PrmWriteErrorEnumAc.hpp.

Member Function Documentation

◆ deserializeFrom()

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

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 68 of file PrmDb_PrmWriteErrorEnumAc.cpp.

◆ isValid()

bool Svc::PrmDb_PrmWriteError::isValid ( ) const

Check raw enum value for validity.

Definition at line 49 of file PrmDb_PrmWriteErrorEnumAc.cpp.

◆ operator enum T()

Svc::PrmDb_PrmWriteError::operator enum T ( ) const
inline

Conversion operator.

Definition at line 109 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ operator!=()

bool Svc::PrmDb_PrmWriteError::operator!= ( enum T  e1) const
inline

Inequality operator.

Definition at line 121 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ operator=() [1/2]

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

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 20 of file PrmDb_PrmWriteErrorEnumAc.cpp.

◆ operator=() [2/2]

PrmDb_PrmWriteError & Svc::PrmDb_PrmWriteError::operator= ( enum T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 27 of file PrmDb_PrmWriteErrorEnumAc.cpp.

◆ operator==()

bool Svc::PrmDb_PrmWriteError::operator== ( enum T  e1) const
inline

Equality operator.

Definition at line 115 of file PrmDb_PrmWriteErrorEnumAc.hpp.

◆ serializeTo()

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

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 55 of file PrmDb_PrmWriteErrorEnumAc.cpp.

Member Data Documentation

◆ e

enum T Svc::PrmDb_PrmWriteError::e

The raw enum value.

Definition at line 173 of file PrmDb_PrmWriteErrorEnumAc.hpp.


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