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

#include <Os/Models/FileStatusEnumAc.hpp>

Inheritance diagram for Os::FileStatus:

Public Types
enum	T { OP_OK = 0, DOESNT_EXIST = 1, NO_SPACE = 2, NO_PERMISSION = 3, BAD_SIZE = 4, NOT_OPENED = 5, FILE_EXISTS = 6, NOT_SUPPORTED = 7, INVALID_MODE = 8, INVALID_ARGUMENT = 9, NO_MORE_RESOURCES = 10, OTHER_ERROR = 11, OUTSIDE_SANDBOX = 12 }
	The raw enum type. More...

enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 13 }

using	SerialType = U8
	The serial representation type. More...

using	t = enum T
	For backwards compatibility. More...

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

Public Member Functions
	FileStatus ()
	Constructor (default value of OP_OK) More...

	FileStatus (const enum T e1)
	Constructor (user-provided value) More...

	FileStatus (const SerialType e1)
	Constructor (serial representation value) More...

	FileStatus (const FileStatus &obj)
	Copy constructor. More...

FileStatus &	operator= (const FileStatus &obj)
	Copy assignment operator (object) More...

FileStatus &	operator= (SerialType e1)
	Assignment operator (serial representation value) More...

FileStatus &	operator= (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")

Static Public Member Functions
static bool	isValid (SerialType serialTypeValue)
	Check serial type value for validity. More...

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

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

Definition at line 18 of file FileStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

using Os::FileStatus::SerialType = U8

The serial representation type.

Definition at line 29 of file FileStatusEnumAc.hpp.

◆ t

using Os::FileStatus::t = enum T

For backwards compatibility.

Definition at line 62 of file FileStatusEnumAc.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 70 of file FileStatusEnumAc.hpp.

◆ T

enum Os::FileStatus::T

The raw enum type.

Enumerator
OP_OK	Operation was successful.
DOESNT_EXIST	File doesn't exist (for read)
NO_SPACE	No space left.
NO_PERMISSION	No permission to read/write file.
BAD_SIZE	Invalid size parameter.
NOT_OPENED	file hasn't been opened yet
FILE_EXISTS	file already exist (for CREATE with O_EXCL enabled)
NOT_SUPPORTED	Kernel or file system does not support operation.
INVALID_MODE	Mode for file access is invalid for current operation.
INVALID_ARGUMENT	Invalid argument passed in.
NO_MORE_RESOURCES	No more available resources.
OTHER_ERROR	A catch-all for other errors. Have to look in implementation-specific code.
OUTSIDE_SANDBOX	Path falls outside the configured sandbox directory.

Definition at line 32 of file FileStatusEnumAc.hpp.

Constructor & Destructor Documentation

◆ FileStatus() [1/4]

Os::FileStatus::FileStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 84 of file FileStatusEnumAc.hpp.

◆ FileStatus() [2/4]

Os::FileStatus::FileStatus ( const enum T e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 90 of file FileStatusEnumAc.hpp.

◆ FileStatus() [3/4]

Os::FileStatus::FileStatus ( const SerialType e1 )

inline

Constructor (serial representation value)

Parameters

e1	The serial representation value

Definition at line 99 of file FileStatusEnumAc.hpp.

◆ FileStatus() [4/4]

Os::FileStatus::FileStatus ( const FileStatus & obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 108 of file FileStatusEnumAc.hpp.

Member Function Documentation

◆ deserializeFrom()

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

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 93 of file FileStatusEnumAc.cpp.

◆ isValid() [1/2]

bool Os::FileStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 69 of file FileStatusEnumAc.cpp.

◆ isValid() [2/2]

bool Os::FileStatus::isValid ( SerialType serialTypeValue )

static

Check serial type value for validity.

Parameters

serialTypeValue The serial type value

Definition at line 180 of file FileStatusEnumAc.cpp.

◆ operator enum T()

Os::FileStatus::operator enum T ( ) const

inline

Conversion operator.

Definition at line 141 of file FileStatusEnumAc.hpp.

◆ operator!=()

bool Os::FileStatus::operator!= ( enum T e1 ) const

inline

Inequality operator.

Definition at line 153 of file FileStatusEnumAc.hpp.

◆ operator=() [1/3]

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

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file FileStatusEnumAc.cpp.

◆ operator=() [2/3]

FileStatus & Os::FileStatus::operator= ( SerialType e1 )

Assignment operator (serial representation value)

Parameters

e1	The serial representation value

Definition at line 30 of file FileStatusEnumAc.cpp.

◆ operator=() [3/3]

FileStatus & Os::FileStatus::operator= ( enum T e1 )

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 42 of file FileStatusEnumAc.cpp.

◆ operator==()

bool Os::FileStatus::operator== ( enum T e1 ) const

inline

Equality operator.

Definition at line 147 of file FileStatusEnumAc.hpp.

◆ serializeTo()

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

virtual

Serialize raw enum value to SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 75 of file FileStatusEnumAc.cpp.

Member Data Documentation

◆ e

enum T Os::FileStatus::e

The raw enum value.

Definition at line 225 of file FileStatusEnumAc.hpp.

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

Os/Models/FileStatusEnumAc.hpp
Os/Models/FileStatusEnumAc.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SerialType

◆ t

Member Enumeration Documentation

◆ anonymous enum

◆ T

Constructor & Destructor Documentation

◆ FileStatus() [1/4]

◆ FileStatus() [2/4]

◆ FileStatus() [3/4]

◆ FileStatus() [4/4]

Member Function Documentation

◆ deserializeFrom()

◆ isValid() [1/2]

◆ isValid() [2/2]

◆ operator enum T()

◆ operator!=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ serializeTo()

Member Data Documentation

◆ e