Os::DirectoryOpenMode Class Reference

#include <Os/Models/DirectoryOpenModeEnumAc.hpp>

Inheritance diagram for Os::DirectoryOpenMode:

Public Types
enum	T { READ = 0, CREATE_IF_MISSING = 1, CREATE_EXCLUSIVE = 2 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 3 }
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
	DirectoryOpenMode ()
	Constructor (default value of READ) More...
	DirectoryOpenMode (const enum T e1)
	Constructor (user-provided value) More...
	DirectoryOpenMode (const SerialType e1)
	Constructor (serial representation value) More...
	DirectoryOpenMode (const DirectoryOpenMode &obj)
	Copy constructor. More...
DirectoryOpenMode &	operator= (const DirectoryOpenMode &obj)
	Copy assignment operator (object) More...
DirectoryOpenMode &	operator= (SerialType e1)
	Assignment operator (serial representation value) More...
DirectoryOpenMode &	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

Definition at line 17 of file DirectoryOpenModeEnumAc.hpp.

Member Typedef Documentation

SerialType

using Os::DirectoryOpenMode::SerialType = U8

The serial representation type.

Definition at line 28 of file DirectoryOpenModeEnumAc.hpp.

t

using Os::DirectoryOpenMode::t = enum T

For backwards compatibility.

Definition at line 41 of file DirectoryOpenModeEnumAc.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 49 of file DirectoryOpenModeEnumAc.hpp.

T

enum Os::DirectoryOpenMode::T

The raw enum type.

Enumerator
READ	Error if directory doesn't exist.
CREATE_IF_MISSING	Create directory if it doesn't exist.
CREATE_EXCLUSIVE	Create directory and error if it already exists.

Definition at line 31 of file DirectoryOpenModeEnumAc.hpp.

Constructor & Destructor Documentation

DirectoryOpenMode() [1/4]

Os::DirectoryOpenMode::DirectoryOpenMode ( )

inline

Constructor (default value of READ)

Definition at line 63 of file DirectoryOpenModeEnumAc.hpp.

DirectoryOpenMode() [2/4]

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

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 69 of file DirectoryOpenModeEnumAc.hpp.

DirectoryOpenMode() [3/4]

Os::DirectoryOpenMode::DirectoryOpenMode ( const SerialType  e1 )

inline

Constructor (serial representation value)

Parameters

e1	The serial representation value

Definition at line 78 of file DirectoryOpenModeEnumAc.hpp.

DirectoryOpenMode() [4/4]

Os::DirectoryOpenMode::DirectoryOpenMode ( const DirectoryOpenMode &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 87 of file DirectoryOpenModeEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Os::DirectoryOpenMode::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 DirectoryOpenModeEnumAc.cpp.

isValid() [1/2]

bool Os::DirectoryOpenMode::isValid

(

)

const

Check raw enum value for validity.

Definition at line 69 of file DirectoryOpenModeEnumAc.cpp.

isValid() [2/2]

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

static

Check serial type value for validity.

Parameters

serialTypeValue

The serial type value

Definition at line 150 of file DirectoryOpenModeEnumAc.cpp.

operator enum T()

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

inline

Conversion operator.

Definition at line 120 of file DirectoryOpenModeEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 132 of file DirectoryOpenModeEnumAc.hpp.

operator=() [1/3]

DirectoryOpenMode & Os::DirectoryOpenMode::operator=

(

const DirectoryOpenMode &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file DirectoryOpenModeEnumAc.cpp.

operator=() [2/3]

DirectoryOpenMode & Os::DirectoryOpenMode::operator=

(

SerialType

e1

)

Assignment operator (serial representation value)

Parameters

e1	The serial representation value

Definition at line 30 of file DirectoryOpenModeEnumAc.cpp.

operator=() [3/3]

DirectoryOpenMode & Os::DirectoryOpenMode::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 42 of file DirectoryOpenModeEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 126 of file DirectoryOpenModeEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Os::DirectoryOpenMode::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 DirectoryOpenModeEnumAc.cpp.

Member Data Documentation

e

enum T Os::DirectoryOpenMode::e

The raw enum value.

Definition at line 204 of file DirectoryOpenModeEnumAc.hpp.

---

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

• Os/Models/DirectoryOpenModeEnumAc.hpp
• Os/Models/DirectoryOpenModeEnumAc.cpp