Os::FileSystemStatus Class Reference

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

#include <Os/Models/FileSystemStatusEnumAc.hpp>

Inheritance diagram for Os::FileSystemStatus:

Public Types
enum	T {   OP_OK = 0 , ALREADY_EXISTS = 1 , NO_SPACE = 2 , NO_PERMISSION = 3 ,   NOT_DIR = 4 , IS_DIR = 5 , NOT_EMPTY = 6 , INVALID_PATH = 7 ,   DOESNT_EXIST = 8 , FILE_LIMIT = 9 , BUSY = 10 , NO_MORE_FILES = 11 ,   BUFFER_TOO_SMALL = 12 , EXDEV_ERROR = 13 , OVERFLOW_ERROR = 14 , NOT_SUPPORTED = 15 ,   OTHER_ERROR = 16 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 17 }
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
	FileSystemStatus ()
	Constructor (default value of OP_OK) More...
	FileSystemStatus (const T e1)
	Constructor (user-provided value) More...
	FileSystemStatus (const FileSystemStatus &obj)
	Copy constructor. More...
FileSystemStatus &	operator= (const FileSystemStatus &obj)
	Copy assignment operator (object) More...
FileSystemStatus &	operator= (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::FileSystem::Status.

Definition at line 17 of file FileSystemStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Os::FileSystemStatus::SerialType

The serial representation type.

Definition at line 28 of file FileSystemStatusEnumAc.hpp.

t

typedef T Os::FileSystemStatus::t

For backwards compatibility.

Definition at line 69 of file FileSystemStatusEnumAc.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 77 of file FileSystemStatusEnumAc.hpp.

T

enum Os::FileSystemStatus::T

The raw enum type.

Enumerator
OP_OK	Operation was successful.
ALREADY_EXISTS	File already exists.
NO_SPACE	No space left.
NO_PERMISSION	No permission to write.
NOT_DIR	Path is not a directory.
IS_DIR	Path is a directory.
NOT_EMPTY	directory is not empty
INVALID_PATH	Path is too long, too many sym links, etc.
DOESNT_EXIST	Path doesn't exist.
FILE_LIMIT	Too many files or links.
BUSY	Operand is in use by the system or by a process.
NO_MORE_FILES	Directory stream has no more files.
BUFFER_TOO_SMALL	Buffer size is too small to hold full path (for getWorkingDirectory)
EXDEV_ERROR	Operation not supported across devices (e.g. rename)
OVERFLOW_ERROR	Operation failed due to overflow in calculation of the result.
NOT_SUPPORTED	Operation is not supported by the current implementation.
OTHER_ERROR	other OS-specific error

Definition at line 31 of file FileSystemStatusEnumAc.hpp.

Constructor & Destructor Documentation

FileSystemStatus() [1/3]

Os::FileSystemStatus::FileSystemStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 91 of file FileSystemStatusEnumAc.hpp.

FileSystemStatus() [2/3]

Os::FileSystemStatus::FileSystemStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 97 of file FileSystemStatusEnumAc.hpp.

FileSystemStatus() [3/3]

Os::FileSystemStatus::FileSystemStatus ( const FileSystemStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 105 of file FileSystemStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Os::FileSystemStatus::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 63 of file FileSystemStatusEnumAc.cpp.

isValid()

bool Os::FileSystemStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file FileSystemStatusEnumAc.cpp.

operator T()

Os::FileSystemStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 129 of file FileSystemStatusEnumAc.hpp.

operator!=()

bool Os::FileSystemStatus::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 141 of file FileSystemStatusEnumAc.hpp.

operator=() [1/2]

FileSystemStatus & Os::FileSystemStatus::operator=

(

const FileSystemStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file FileSystemStatusEnumAc.cpp.

operator=() [2/2]

FileSystemStatus & Os::FileSystemStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file FileSystemStatusEnumAc.cpp.

operator==()

bool Os::FileSystemStatus::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 135 of file FileSystemStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Os::FileSystemStatus::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 54 of file FileSystemStatusEnumAc.cpp.

Member Data Documentation

e

T Os::FileSystemStatus::e

The raw enum value.

Definition at line 191 of file FileSystemStatusEnumAc.hpp.

---

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

• Os/Models/FileSystemStatusEnumAc.hpp
• Os/Models/FileSystemStatusEnumAc.cpp