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

FPP shadow-enum representing Os::Task::Status. More...

#include <Os/Models/TaskStatusEnumAc.hpp>

Inheritance diagram for Os::TaskStatus:
Fw::Serializable

Public Types

enum  T {
  OP_OK = 0 , INVALID_HANDLE = 1 , INVALID_PARAMS = 2 , INVALID_STACK = 3 ,
  UNKNOWN_ERROR = 4 , INVALID_AFFINITY = 5 , DELAY_ERROR = 6 , JOIN_ERROR = 7 ,
  ERROR_RESOURCES = 8 , ERROR_PERMISSION = 9 , INVALID_STATE = 10
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 11 }
 
typedef I32 SerialType
 The serial representation type. More...
 
typedef T t
 For backwards compatibility. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = NATIVE_UINT_TYPE
 

Public Member Functions

 TaskStatus ()
 Constructor (default value of OP_OK) More...
 
 TaskStatus (const T e1)
 Constructor (user-provided value) More...
 
 TaskStatus (const TaskStatus &obj)
 Copy constructor. More...
 
TaskStatusoperator= (const TaskStatus &obj)
 Copy assignment operator (object) More...
 
TaskStatusoperator= (T e1)
 Copy assignment operator (raw enum) More...
 
 operator T () const
 Conversion operator. More...
 
bool operator== (T e1) const
 Equality operator. More...
 
bool operator!= (T e1) const
 Inequality operator. More...
 
bool isValid () const
 Check raw enum value for validity. More...
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialize raw enum value to SerialType. More...
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialize raw enum value from SerialType. More...
 

Public Attributes

T e
 The raw enum value. More...
 

Additional Inherited Members

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

Detailed Description

FPP shadow-enum representing Os::Task::Status.

Definition at line 17 of file TaskStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file TaskStatusEnumAc.hpp.

◆ t

For backwards compatibility.

Definition at line 57 of file TaskStatusEnumAc.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 65 of file TaskStatusEnumAc.hpp.

◆ T

The raw enum type.

Enumerator
OP_OK 

message sent/received okay

INVALID_HANDLE 

Task handle invalid.

INVALID_PARAMS 

started task with invalid parameters

INVALID_STACK 

started with invalid stack size

UNKNOWN_ERROR 

unexpected error return value

INVALID_AFFINITY 

unable to set the task affinity

DELAY_ERROR 

error trying to delay the task

JOIN_ERROR 

error trying to join the task

ERROR_RESOURCES 

unable to allocate more tasks

ERROR_PERMISSION 

permissions error setting-up tasks

INVALID_STATE 

Task is in an invalid state for the operation.

Definition at line 31 of file TaskStatusEnumAc.hpp.

Constructor & Destructor Documentation

◆ TaskStatus() [1/3]

Os::TaskStatus::TaskStatus ( )
inline

Constructor (default value of OP_OK)

Definition at line 79 of file TaskStatusEnumAc.hpp.

◆ TaskStatus() [2/3]

Os::TaskStatus::TaskStatus ( const T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 85 of file TaskStatusEnumAc.hpp.

◆ TaskStatus() [3/3]

Os::TaskStatus::TaskStatus ( const TaskStatus obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 93 of file TaskStatusEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Os::TaskStatus::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file TaskStatusEnumAc.cpp.

◆ isValid()

bool Os::TaskStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file TaskStatusEnumAc.cpp.

◆ operator T()

Os::TaskStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 117 of file TaskStatusEnumAc.hpp.

◆ operator!=()

bool Os::TaskStatus::operator!= ( T  e1) const
inline

Inequality operator.

Definition at line 129 of file TaskStatusEnumAc.hpp.

◆ operator=() [1/2]

TaskStatus & Os::TaskStatus::operator= ( const TaskStatus obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file TaskStatusEnumAc.cpp.

◆ operator=() [2/2]

TaskStatus & Os::TaskStatus::operator= ( T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 26 of file TaskStatusEnumAc.cpp.

◆ operator==()

bool Os::TaskStatus::operator== ( T  e1) const
inline

Equality operator.

Definition at line 123 of file TaskStatusEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Os::TaskStatus::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 54 of file TaskStatusEnumAc.cpp.

Member Data Documentation

◆ e

T Os::TaskStatus::e

The raw enum value.

Definition at line 179 of file TaskStatusEnumAc.hpp.


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