CMagneticHeadingFilterSwc Class Reference

Inheritance diagram for CMagneticHeadingFilterSwc:

Public Member Functions
void	Init () override
bool	IsInitialized () override
void	SetAttitudeInput ()
	A wrapper around MagneticHeadingFilterApi::MagneticHeadingFilterSetInput().
void	Step (uint64_t uTimestampUs)
	A wrapper around MagneticHeadingFilterApi::MagneticHeadingFilterStep().
Public Member Functions inherited from CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >
	CSoftwareComponent (CSoftwareComponent &)=delete
	CSoftwareComponent (CSoftwareComponent &&)=delete
CSoftwareComponent &	operator= (const CSoftwareComponent &orOther)=delete
CSoftwareComponent &	operator= (CSoftwareComponent &&orOther)=delete
virtual void	Init ()=0
virtual bool	IsInitialized ()=0

Private Types
typedef StaticSemaphore_t	osStaticMutexDef_t

Private Member Functions
	CMagneticHeadingFilterSwc (CMagneticHeadingFilterSwc &)=delete
	CMagneticHeadingFilterSwc (CMagneticHeadingFilterSwc &&)=delete
CMagneticHeadingFilterSwc &	operator= (const CMagneticHeadingFilterSwc &orOther)=delete
CMagneticHeadingFilterSwc &	operator= (CMagneticHeadingFilterSwc &&orOther)=delete
	CMagneticHeadingFilterSwc ()
	The constructor creates a mutex for shared BAHRS filter data.
	~CMagneticHeadingFilterSwc ()=default

Static Private Member Functions
static CMagneticHeadingFilterSwc &	getInstanceImpl (unsigned uInstanceIndex)

Private Attributes
osMutexId_t	pMutexHandle_
	Mutex handle.
osStaticMutexDef_t	sMutexControlBlock_
	Memory reserved for the mutex control block.
const osMutexAttr_t	sMutexAttributes_ { NULL, 0, &sMutexControlBlock_, sizeof(sMutexControlBlock_) }
	A structure with mutex attributes required for creation.

Friends
class	CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >

Additional Inherited Members
Static Public Member Functions inherited from CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >
static CMagneticHeadingFilterSwc &	GetInstance (unsigned uInstanceIndex=0U)
Static Public Attributes inherited from CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >
static constexpr unsigned	skuInstanceCount_
Protected Member Functions inherited from CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >
	CSoftwareComponent ()=default
	~CSoftwareComponent ()=default

Member Typedef Documentation

osStaticMutexDef_t

typedef StaticSemaphore_t CMagneticHeadingFilterSwc::osStaticMutexDef_t

private

The typedef copied from a CMSIS_OS header.

Constructor & Destructor Documentation

CMagneticHeadingFilterSwc() [1/3]

CMagneticHeadingFilterSwc::CMagneticHeadingFilterSwc ( CMagneticHeadingFilterSwc &  )

privatedelete

CMagneticHeadingFilterSwc() [2/3]

CMagneticHeadingFilterSwc::CMagneticHeadingFilterSwc ( CMagneticHeadingFilterSwc &&  )

privatedelete

CMagneticHeadingFilterSwc() [3/3]

CMagneticHeadingFilterSwc::CMagneticHeadingFilterSwc ( )

private

The constructor creates a mutex for shared BAHRS filter data.

~CMagneticHeadingFilterSwc()

CMagneticHeadingFilterSwc::~CMagneticHeadingFilterSwc ( )

privatedefault

Member Function Documentation

getInstanceImpl()

CMagneticHeadingFilterSwc & CMagneticHeadingFilterSwc::getInstanceImpl ( unsigned  uInstanceIndex )

staticprivate

Init()

void CMagneticHeadingFilterSwc::Init ( )

overridevirtual

Initialize the software component.

Implements CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >.

IsInitialized()

bool CMagneticHeadingFilterSwc::IsInitialized ( )

overridevirtual

Get initialization status of the software component.

Returns

True – the component is initialized, false otherwise.

Implements CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >.

operator=() [1/2]

CMagneticHeadingFilterSwc & CMagneticHeadingFilterSwc::operator= ( CMagneticHeadingFilterSwc &&  orOther )

privatedelete

operator=() [2/2]

CMagneticHeadingFilterSwc & CMagneticHeadingFilterSwc::operator= ( const CMagneticHeadingFilterSwc &  orOther )

privatedelete

SetAttitudeInput()

void CMagneticHeadingFilterSwc::SetAttitudeInput

(

)

A wrapper around MagneticHeadingFilterApi::MagneticHeadingFilterSetInput().

Step()

void CMagneticHeadingFilterSwc::Step

(

uint64_t

uTimestampUs

)

A wrapper around MagneticHeadingFilterApi::MagneticHeadingFilterStep().

Parameters

uTimestampUs

Time of the API call in microseconds.

Friends And Related Function Documentation

CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >

friend class CSoftwareComponent< CMagneticHeadingFilterSwc, 1U >

friend

Member Data Documentation

pMutexHandle_

osMutexId_t CMagneticHeadingFilterSwc::pMutexHandle_

private

Mutex handle.

sMutexAttributes_

const osMutexAttr_t CMagneticHeadingFilterSwc::sMutexAttributes_ { NULL, 0, &sMutexControlBlock_, sizeof(sMutexControlBlock_) }

private

A structure with mutex attributes required for creation.

sMutexControlBlock_

osStaticMutexDef_t CMagneticHeadingFilterSwc::sMutexControlBlock_

private

Memory reserved for the mutex control block.

---

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

• CMagneticHeadingFilterSwc.h
• CMagneticHeadingFilterSwc.cpp