Os::FileStatus Class Reference

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 , OTHER_ERROR = 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
	FileStatus ()
	Constructor (default value of OP_OK) More...
	FileStatus (const T e1)
	Constructor (user-provided value) More...
	FileStatus (const FileStatus &obj)
	Copy constructor. More...
FileStatus &	operator= (const FileStatus &obj)
	Copy assignment operator (object) More...
FileStatus &	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::File::Status.

Definition at line 17 of file FileStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Os::FileStatus::SerialType

The serial representation type.

Definition at line 28 of file FileStatusEnumAc.hpp.

t

typedef T Os::FileStatus::t

For backwards compatibility.

Definition at line 57 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 65 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.
OTHER_ERROR	A catch-all for other errors. Have to look in implementation-specific code.

Definition at line 31 of file FileStatusEnumAc.hpp.

Constructor & Destructor Documentation

FileStatus() [1/3]

Os::FileStatus::FileStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 79 of file FileStatusEnumAc.hpp.

FileStatus() [2/3]

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

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 85 of file FileStatusEnumAc.hpp.

FileStatus() [3/3]

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

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 93 of file FileStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Os::FileStatus::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 FileStatusEnumAc.cpp.

isValid()

bool Os::FileStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file FileStatusEnumAc.cpp.

operator T()

Os::FileStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 117 of file FileStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 129 of file FileStatusEnumAc.hpp.

operator=() [1/2]

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/2]

FileStatus & Os::FileStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file FileStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 123 of file FileStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Os::FileStatus::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 FileStatusEnumAc.cpp.

Member Data Documentation

e

T Os::FileStatus::e

The raw enum value.

Definition at line 179 of file FileStatusEnumAc.hpp.

---

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

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