F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Fw::Buffer Class Reference

#include <build-fprime-automatic-native/F-Prime/Fw/Buffer/BufferSerializableAc.hpp>

Inheritance diagram for Fw::Buffer:
Fw::Serializable

Public Types

enum  { SERIALIZED_SIZE }
 

Public Member Functions

 Buffer (void)
 Default constructor. More...
 
 Buffer (const Buffer *src)
 pointer copy constructor More...
 
 Buffer (const Buffer &src)
 reference copy constructor More...
 
 Buffer (U32 managerID, U32 bufferID, U64 data, U32 size)
 constructor with arguments More...
 
const Bufferoperator= (const Buffer &src)
 equal operator More...
 
bool operator== (const Buffer &src) const
 equality operator More...
 
void set (U32 managerID, U32 bufferID, U64 data, U32 size)
 set values More...
 
U32 getmanagerID (void)
 get member managerID More...
 
U32 getbufferID (void)
 get member bufferID More...
 
U64 getdata (void)
 get member data More...
 
U32 getsize (void)
 get member size More...
 
void setmanagerID (U32 val)
 set member managerID More...
 
void setbufferID (U32 val)
 set member bufferID More...
 
void setdata (U64 val)
 set member data More...
 
void setsize (U32 val)
 set member size More...
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 serialization function More...
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 deserialization function More...
 

Protected Types

enum  { TYPE_ID = 0xA4583D9C }
 

Protected Attributes

U32 m_managerID
 
U32 m_bufferID
 
U64 m_data
 
U32 m_size
 

Additional Inherited Members

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

Detailed Description

Definition at line 24 of file BufferSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

Definition at line 29 of file BufferSerializableAc.hpp.

◆ anonymous enum

anonymous enum
protected
Enumerator
TYPE_ID 

type id

Definition at line 68 of file BufferSerializableAc.hpp.

Constructor & Destructor Documentation

◆ Buffer() [1/4]

Fw::Buffer::Buffer ( void  )

Default constructor.

Definition at line 11 of file BufferSerializableAc.cpp.

◆ Buffer() [2/4]

Fw::Buffer::Buffer ( const Buffer src)

pointer copy constructor

Definition at line 19 of file BufferSerializableAc.cpp.

◆ Buffer() [3/4]

Fw::Buffer::Buffer ( const Buffer src)

reference copy constructor

Definition at line 15 of file BufferSerializableAc.cpp.

◆ Buffer() [4/4]

Fw::Buffer::Buffer ( U32  managerID,
U32  bufferID,
U64  data,
U32  size 
)

constructor with arguments

Definition at line 24 of file BufferSerializableAc.cpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Fw::Buffer::deserialize ( Fw::SerializeBufferBase buffer)
virtual

deserialization function

Implements Fw::Serializable.

Definition at line 104 of file BufferSerializableAc.cpp.

◆ getbufferID()

U32 Fw::Buffer::getbufferID ( void  )

get member bufferID

Definition at line 53 of file BufferSerializableAc.cpp.

◆ getdata()

U64 Fw::Buffer::getdata ( void  )

get member data

Definition at line 57 of file BufferSerializableAc.cpp.

◆ getmanagerID()

U32 Fw::Buffer::getmanagerID ( void  )

get member managerID

Definition at line 49 of file BufferSerializableAc.cpp.

◆ getsize()

U32 Fw::Buffer::getsize ( void  )

get member size

Definition at line 61 of file BufferSerializableAc.cpp.

◆ operator=()

const Buffer & Fw::Buffer::operator= ( const Buffer src)

equal operator

Definition at line 28 of file BufferSerializableAc.cpp.

◆ operator==()

bool Fw::Buffer::operator== ( const Buffer src) const

equality operator

Definition at line 33 of file BufferSerializableAc.cpp.

◆ serialize()

Fw::SerializeStatus Fw::Buffer::serialize ( Fw::SerializeBufferBase buffer) const
virtual

serialization function

Implements Fw::Serializable.

Definition at line 77 of file BufferSerializableAc.cpp.

◆ set()

void Fw::Buffer::set ( U32  managerID,
U32  bufferID,
U64  data,
U32  size 
)

set values

Definition at line 42 of file BufferSerializableAc.cpp.

◆ setbufferID()

void Fw::Buffer::setbufferID ( U32  val)

set member bufferID

Definition at line 68 of file BufferSerializableAc.cpp.

◆ setdata()

void Fw::Buffer::setdata ( U64  val)

set member data

Definition at line 71 of file BufferSerializableAc.cpp.

◆ setmanagerID()

void Fw::Buffer::setmanagerID ( U32  val)

set member managerID

Definition at line 65 of file BufferSerializableAc.cpp.

◆ setsize()

void Fw::Buffer::setsize ( U32  val)

set member size

Definition at line 74 of file BufferSerializableAc.cpp.

Member Data Documentation

◆ m_bufferID

U32 Fw::Buffer::m_bufferID
protected

Definition at line 73 of file BufferSerializableAc.hpp.

◆ m_data

U64 Fw::Buffer::m_data
protected

Definition at line 74 of file BufferSerializableAc.hpp.

◆ m_managerID

U32 Fw::Buffer::m_managerID
protected

Definition at line 72 of file BufferSerializableAc.hpp.

◆ m_size

U32 Fw::Buffer::m_size
protected

Definition at line 75 of file BufferSerializableAc.hpp.


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