This concrete class implements the "Record" class for storing the 'Personality' settings. More...

Detailed Description

This concrete class implements the "Record" class for storing the 'Personality' settings.

#include <PersonalityRecord.h>

Inheritance diagram for Ajax::Main::PersonalityRecord:

Collaboration diagram for Ajax::Main::PersonalityRecord:

Public Member Functions
	PersonalityRecord (Cpl::Persistent::Chunk &chunkHandler)
	Constructor.

bool	resetData () noexcept
	See Cpl::Dm::Persistent::Record.

Public Member Functions inherited from Cpl::Dm::Persistent::Record
	Record (Item_T itemList[], Cpl::Persistent::Chunk &chunkHandler, uint8_t schemaMajorIndex, uint8_t schemaMinorIndex, uint32_t writeDelayMs=0, uint32_t maxWriteDelayMs=0) noexcept
	Constructor.

	~Record ()
	Destructor.

void	start (Cpl::Dm::MailboxServer &myMbox) noexcept
	See Cpl::Persistent::Record.

void	stop () noexcept
	See Cpl::Persistent::Record.

size_t	getData (void *dst, size_t maxDstLen) noexcept
	See Cpl::Persistent::Payload.

bool	putData (const void *src, size_t srcLen) noexcept
	See Cpl::Persistent::Payload.

size_t	getRecordSize () noexcept
	Returns the size of record. Does NOT include any meta-data that the Chunk Handler adds.

bool	flush (Cpl::Persistent::RecordServer &myRecordsServer) noexcept
	Synchronous Flush/update of the Record to persistent storage.

bool	erase (Cpl::Persistent::RecordServer &myRecordsServer) noexcept
	Synchronous Invalidate/logically-erase of the Record in persistent storage.

void	request (FlushMsg &msg)
	See Cpl::Dm::Persistent::FlushRequest.

void	request (EraseMsg &msg)
	See Cpl::Dm::Persistent::EraseRequest.

Public Member Functions inherited from Cpl::Persistent::Payload
virtual	~Payload ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Dm::Persistent::FlushRequest
virtual	~FlushRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Dm::Persistent::EraseRequest
virtual	~EraseRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::System::Timer
	Timer (TimerManager &timingSource)
	Constructor

	Timer ()
	Constructor. Alternate constructor - that defers the assignment of the timing source

virtual void	start (unsigned long timerDurationInMilliseconds) noexcept
	Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.

unsigned long	count () const noexcept
	Returns the current count (in milliseconds)

virtual void	setTimingSource (TimerManager &timingSource) noexcept
	Sets the timing source.

Public Member Functions inherited from Cpl::System::CounterCallback_
virtual	~CounterCallback_ ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
Cpl::Dm::Persistent::Record::Item_T	m_modelPoints [9+1]
	List of Model Points for the Record.

Protected Attributes inherited from Cpl::Dm::Persistent::Record
Item_T *	m_items
	List of model points.

Cpl::Persistent::Chunk &	m_chunkHandler
	Chunk handler for the Record.

uint32_t	m_delayMs
	Delay time, in milliseconds, when updated NVRAM (i.e. 'settling time' after an MP update before writing NVRAM)

uint32_t	m_maxDelayMs
	Maximum amount of time, in milliseconds, to delay before updating NVRAM.

uint32_t	m_timerMarker
	Timer marker of the 'first' MP change notification (for a NVRAM update)

uint8_t	m_major
	Schema Major version.

uint8_t	m_minor
	Schema Minor version.

bool	m_started
	Remember my started state.

Protected Attributes inherited from Cpl::System::Timer
TimerManager *	m_timingSource
	The timer's tick source.

unsigned long	m_count
	Current count.

Additional Inherited Members
Public Types inherited from Cpl::Dm::Persistent::FlushRequest
typedef Cpl::Itc::SAP< FlushRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< FlushRequest, Payload >	FlushMsg
	Message Type: GetLatest.

Public Types inherited from Cpl::Dm::Persistent::EraseRequest
typedef Cpl::Itc::SAP< EraseRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< EraseRequest, Payload >	EraseMsg
	Message Type:

Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Member Functions inherited from Cpl::Dm::Persistent::Record
virtual bool	schemaChange (uint8_t previousSchemaMajorIndex, uint8_t previousSchemaMinorIndex, const void *src, size_t srcLen) noexcept
	This method is called when the stored record data has different schema indexes.

virtual void	hookProcessPostRecordLoaded () noexcept
	This method is called when the Record has been successfully loaded into RAM/Model-Points.

void	expired (void) noexcept
	Settling timer expired callback.

virtual void	dataChanged (Cpl::Dm::ModelPoint &point, Cpl::Dm::SubscriberApi &observer) noexcept
	Callback method for Model Point change notifications.

virtual void	updateNVRAM () noexcept
	Helper method that is used to initiate the update to the NVRAM.

Protected Member Functions inherited from Cpl::System::Timer
void	decrement (unsigned long milliseconds=1) noexcept
	See Cpl::System::CounterCallback_.

void	increment (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

◆ PersonalityRecord()

Ajax::Main::PersonalityRecord::PersonalityRecord ( Cpl::Persistent::Chunk & chunkHandler )

inline

Constructor.

Member Function Documentation

◆ resetData()

bool Ajax::Main::PersonalityRecord::resetData ( )

inlinevirtualnoexcept

See Cpl::Dm::Persistent::Record.

Implements Cpl::Dm::Persistent::Record.

Member Data Documentation

◆ m_modelPoints

Cpl::Dm::Persistent::Record::Item_T Ajax::Main::PersonalityRecord::m_modelPoints[9+1]

protected

List of Model Points for the Record.

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

Ajax/Main/PersonalityRecord.h