This a mostly concrete class provides 'common' implementation for a Model Point who's data is a array of elements. More...

Detailed Description

This a mostly concrete class provides 'common' implementation for a Model Point who's data is a array of elements.

The toJSON()/fromJSON format is:

{ name:"<mpname>", type:"<mptypestring>", valid:true|false seqnum:nnnn, locked:true|false, val:{start:<firstIndex>,elems:[<elemN>,<elemN+1>,...]}}" }

#include <Array.h>

Inheritance diagram for Cpl::Dm::Mp::ArrayBase_:

[legend]

Collaboration diagram for Cpl::Dm::Mp::ArrayBase_:

[legend]

Classes
struct	MetaData_T
	Meta data for read/write/copy operations. More...

Public Member Functions
size_t	getNumElements () const noexcept
	Returns the number of element in the array. This method IS thread safe.

void	copyDataTo_ (void *dstData, size_t dstSize) const noexcept
	See Cpl::Dm::ModelPoint.

void	copyDataFrom_ (const void *srcData, size_t srcSize) noexcept
	See Cpl::Dm::ModelPoint.

bool	isDataEqual_ (const void *otherData) const noexcept
	See Cpl::Dm::ModelPoint.

size_t	getInternalDataSize_ () const noexcept
	See Cpl::Dm::Point.

bool	importMetadata_ (const void *srcDataStream, size_t &bytesConsumed) noexcept
	See Cpl::Dm::ModelPoint.

bool	exportMetadata_ (void *dstDataStream, size_t &bytesAdded) const noexcept
	See Cpl::Dm::ModelPoint.

Public Member Functions inherited from Cpl::Dm::ModelPointCommon_
const char *	getName () const noexcept
	See Cpl::Dm::ModelPoint.

size_t	getSize () const noexcept
	See Cpl::Dm::ModelPoint. This method IS thread safe.

uint16_t	getSequenceNumber () const noexcept
	See Cpl::Dm::ModelPoint.

uint16_t	touch () noexcept
	See Cpl::Dm::ModelPoint.

uint16_t	setInvalid (LockRequest_T lockRequest=eNO_REQUEST) noexcept
	See Cpl::Dm::ModelPoint.

bool	isNotValid (uint16_t *seqNumPtr=0) const noexcept
	See Cpl::Dm::ModelPoint.

bool	isLocked () const noexcept
	See Cpl::Dm::ModelPoint.

uint16_t	setLockState (LockRequest_T lockRequest) noexcept
	See Cpl::Dm::ModelPoint.

size_t	getExternalSize (bool includeLockedState=false) const noexcept
	See Cpl::Dm::ModelPoint.

size_t	exportData (void dstDataStream, size_t maxDstLength, uint16_t retSequenceNumber=0, bool includeLockedState=false) const noexcept
	See Cpl::Dm::ModelPoint. Note: The implementation does NOT account for Endianess, i.e. assumes the 'platform' is the same for export/import.

size_t	importData (const void srcDataStream, size_t srcLength, uint16_t retSequenceNumber=0, bool includeLockedState=false) noexcept
	See Cpl::Dm::ModelPoint. Note: The implementation does NOT account for Endianess, i.e. assumes the 'platform' is the same for export/import.

void	genericAttach (SubscriberApi &observer, uint16_t initialSeqNumber=SEQUENCE_NUMBER_UNKNOWN) noexcept
	See Cpl::Dm::ModelPoint.

void	genericDetach (SubscriberApi &observer) noexcept
	See Cpl::Dm::ModelPoint.

bool	toJSON (char *dst, size_t dstSize, bool &truncated, bool verbose=true, bool pretty=false) noexcept
	See Cpl::Dm::ModelPoint.

bool	isNotValidAndSync (SubscriberApi &observerToSync)
	This method is used to test the validate state of the MP and synchronize the observer with the current MP contents.

void	processSubscriptionEvent_ (SubscriberApi &subscriber, Event_T event) noexcept
	See Cpl::Dm::ModelPoint.

Public Member Functions inherited from Cpl::Dm::ModelPoint
virtual const char *	getTypeAsText () const noexcept=0
	This method returns a string identifier for the Model Point's data type.

uint16_t	removeLock () noexcept
	Short hand for unconditionally removing the lock from the MP.

uint16_t	applyLock () noexcept
	Short hand for putting the MP into the locked state.

virtual bool	fromJSON_ (JsonVariant &src, LockRequest_T lockRequest, uint16_t &retSequenceNumber, Cpl::Text::String *errorMsg) noexcept=0
	This method has PACKAGE Scope, i.e.

virtual	~ModelPoint ()
	Virtual destructor to make the compiler happy.

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 Member Functions
	ArrayBase_ (Cpl::Dm::ModelDatabase &myModelBase, const char symbolicName, void myDataPtr, size_t numElements, size_t elementSize)
	Constructor: Invalid MP.

	ArrayBase_ (Cpl::Dm::ModelDatabase &myModelBase, const char symbolicName, void myDataPtr, size_t numElements, size_t elementSize, void *initialValueSrcPtr)
	Constructor.

virtual bool	readArrayElements (void dstData, size_t dstNumElements, size_t srcIndex=0, uint16_t seqNumPtr=0) const noexcept
	The caller can read a subset of array starting from the specified index in the Model Point's array.

virtual uint16_t	writeArrayElements (const void *srcData, size_t srcNumElements, size_t dstIndex=0, Cpl::Dm::ModelPoint::LockRequest_T lockRequest=Cpl::Dm::ModelPoint::eNO_REQUEST) noexcept
	The caller can write a subset of array starting from the specified index in the Model Point's array.

virtual uint16_t	copyArrayFrom (const ArrayBase_ &src, Cpl::Dm::ModelPoint::LockRequest_T lockRequest=Cpl::Dm::ModelPoint::eNO_REQUEST) noexcept
	Updates the MP with the valid-state/data from 'src'. Note: the src.lock state is NOT copied.

Protected Member Functions inherited from Cpl::Dm::ModelPointCommon_
	ModelPointCommon_ (ModelDatabase &myModelBase, const char symbolicName, void myDataPtr, size_t dataSizeInBytes, bool isValid=false)
	Constructor.

bool	readAndSync (void *dstData, size_t dstSize, SubscriberApi &observerToSync)
	This method is used to read the MP contents and synchronize the observer with the current MP contents.

bool	readData (void dstData, size_t dstSize, uint16_t seqNumPtr=0) const noexcept
	See Cpl::Dm::ModelPoint.

uint16_t	writeData (const void *srcData, size_t srcSize, LockRequest_T lockRequest=eNO_REQUEST) noexcept
	See Cpl::Dm::ModelPoint.

virtual uint16_t	copyDataAndStateFrom (const ModelPointCommon_ &src, LockRequest_T lockRequest) noexcept
	Updates the MP with the valid-state/data from 'src'. Note: the src.lock state is NOT copied.

void	attachSubscriber (SubscriberApi &observer, uint16_t initialSeqNumber=SEQUENCE_NUMBER_UNKNOWN) noexcept
	See Cpl::Dm::ModelPoint.

void	detachSubscriber (SubscriberApi &observer) noexcept
	See Cpl::Dm::ModelPoint.

void	copyDataTo_ (void *dstData, size_t dstSize) const noexcept
	See Cpl::Dm::ModelPoint.

void	copyDataFrom_ (const void *srcData, size_t srcSize) noexcept
	See Cpl::Dm::ModelPoint.

bool	isDataEqual_ (const void *otherData) const noexcept
	See Cpl::Dm::ModelPoint. Note: This implementation does NOT work if the any of the data content are floats/double data types.

const void *	getImportExportDataPointer_ () const noexcept
	See Cpl::Dm::ModelPoint.

size_t	getInternalDataSize_ () const noexcept
	See Cpl::Dm::ModelPoint.

virtual void	processDataUpdated () noexcept
	Internal helper method that completes the data update process as well as ensuring any change notifications get generated.

virtual void	processChangeNotifications () noexcept
	Internal helper method that handles generating change notifications when the Model Point's data/state has changed.

virtual void	advanceSequenceNumber () noexcept
	Internal helper method that advances/updates the Model Point's sequence number.

virtual bool	testAndUpdateLock (LockRequest_T lockRequest) noexcept
	Internal helper method that manages testing and updating the locked state.

virtual void	transitionToNotifyPending (SubscriberApi &subscriber) noexcept
	Helper FSM method.

virtual void	transitionToSubscribed (SubscriberApi &subscriber) noexcept
	Helper FSM method.

virtual JsonDocument &	beginJSON (bool isValid, bool locked, uint16_t seqnum, bool verbose=true) noexcept
	Helper method when converting MP to a JSON string.

virtual void	endJSON (char *dst, size_t dstSize, bool &truncated, bool verbose=true, bool pretty=false) noexcept
	Helper method when converting MP to a JSON string.

virtual void	hookSetInvalid () noexcept
	Helper method that a child a class can override to change behavior when an MP is set to the invalid state.

Protected Member Functions inherited from Cpl::Dm::ModelPoint
virtual void	setJSONVal (JsonDocument &doc) noexcept=0
	This method converts the MP data to a JSON key/value pair.

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.

Protected Attributes
size_t	m_numElements
	Number of elements in the array.

size_t	m_elementSize
	Size, in bytes, of an element.

Protected Attributes inherited from Cpl::Dm::ModelPointCommon_
Cpl::Container::DList< SubscriberApi >	m_subscribers
	List of Active Subscribers.

const char *	m_name
	The model point's symbolic name.

ModelDatabase &	m_modelDatabase
	Reference to the containing Model Base.

void *	m_dataPtr
	Reference to my Data.

size_t	m_dataSize
	Size of my data.

uint16_t	m_seqNum
	Sequence number used for tracking changes in the Point data.

bool	m_locked
	Locked state.

bool	m_valid
	valid/invalid state

Additional Inherited Members
Public Types inherited from Cpl::Dm::ModelPoint
enum	LockRequest_T { eNO_REQUEST , eLOCK , eUNLOCK }
	Options related to the Model Point's locked state. More...

enum	Event_T { eATTACH , eDETACH , eDATA_CHANGED , eNOTIFYING , eNOTIFY_COMPLETE }
	Subscriber events. More...

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::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Static Public Attributes inherited from Cpl::Dm::ModelPoint
static const uint16_t	SEQUENCE_NUMBER_UNKNOWN
	Magic value to use when registering for a change notification and application does not 'know' the current sequence number value of the Model Point.

Class Documentation

◆ Cpl::Dm::Mp::ArrayBase_::MetaData_T

struct Cpl::Dm::Mp::ArrayBase_::MetaData_T

Meta data for read/write/copy operations.

Class Members
size_t	elemIndex	Starting array index.
uint8_t *	elemPtr	Pointer to the 1st element in the array to read/write.
size_t	numElements	Number of element to read/write.

Constructor & Destructor Documentation

◆ ArrayBase_() [1/2]

Cpl::Dm::Mp::ArrayBase_::ArrayBase_	(	Cpl::Dm::ModelDatabase &	myModelBase,
		const char *	symbolicName,
		void *	myDataPtr,
		size_t	numElements,
		size_t	elementSize
	)

protected

Constructor: Invalid MP.

◆ ArrayBase_() [2/2]

Cpl::Dm::Mp::ArrayBase_::ArrayBase_	(	Cpl::Dm::ModelDatabase &	myModelBase,
		const char *	symbolicName,
		void *	myDataPtr,
		size_t	numElements,
		size_t	elementSize,
		void *	initialValueSrcPtr
	)

protected

Constructor.

Valid MP. Requires an initial value. If the 'initialValueSrcPtr' pointer is set to zero, then the entire array will be initialized to zero. Note: The array that 'initialValueSrcPtr' points to ' MUST contain at least 'numElements' elements.

Member Function Documentation

◆ copyArrayFrom()

virtual uint16_t Cpl::Dm::Mp::ArrayBase_::copyArrayFrom	(	const ArrayBase_ &	src,
		Cpl::Dm::ModelPoint::LockRequest_T	lockRequest = `Cpl::Dm::ModelPoint::eNO_REQUEST`
	)

protectedvirtualnoexcept

Updates the MP with the valid-state/data from 'src'. Note: the src.lock state is NOT copied.

◆ copyDataFrom_()

void Cpl::Dm::Mp::ArrayBase_::copyDataFrom_	(	const void *	srcData,
		size_t	srcSize
	)

virtualnoexcept

See Cpl::Dm::ModelPoint.

Implements Cpl::Dm::ModelPoint.

◆ copyDataTo_()

void Cpl::Dm::Mp::ArrayBase_::copyDataTo_	(	void *	dstData,
		size_t	dstSize
	)		const

virtualnoexcept

See Cpl::Dm::ModelPoint.

Implements Cpl::Dm::ModelPoint.

◆ exportMetadata_()

bool Cpl::Dm::Mp::ArrayBase_::exportMetadata_	(	void *	dstDataStream,
		size_t &	bytesAdded
	)		const

virtualnoexcept

See Cpl::Dm::ModelPoint.

Reimplemented from Cpl::Dm::ModelPoint.

◆ getInternalDataSize_()

size_t Cpl::Dm::Mp::ArrayBase_::getInternalDataSize_ ( ) const

virtualnoexcept

See Cpl::Dm::Point.

Implements Cpl::Dm::ModelPoint.

◆ getNumElements()

size_t Cpl::Dm::Mp::ArrayBase_::getNumElements ( ) const

inlinenoexcept

Returns the number of element in the array. This method IS thread safe.

◆ importMetadata_()

bool Cpl::Dm::Mp::ArrayBase_::importMetadata_	(	const void *	srcDataStream,
		size_t &	bytesConsumed
	)

virtualnoexcept

See Cpl::Dm::ModelPoint.

Reimplemented from Cpl::Dm::ModelPoint.

◆ isDataEqual_()

bool Cpl::Dm::Mp::ArrayBase_::isDataEqual_ ( const void * otherData ) const

virtualnoexcept

See Cpl::Dm::ModelPoint.

Implements Cpl::Dm::ModelPoint.

◆ readArrayElements()

virtual bool Cpl::Dm::Mp::ArrayBase_::readArrayElements	(	void *	dstData,
		size_t	dstNumElements,
		size_t	srcIndex = `0`,
		uint16_t *	seqNumPtr = `0`
	)		const

protectedvirtualnoexcept

The caller can read a subset of array starting from the specified index in the Model Point's array.

Note: if srcIndex + dstNumElements exceeds the size of the MP's data then the read operation will be truncated.

◆ writeArrayElements()

virtual uint16_t Cpl::Dm::Mp::ArrayBase_::writeArrayElements	(	const void *	srcData,
		size_t	srcNumElements,
		size_t	dstIndex = `0`,
		Cpl::Dm::ModelPoint::LockRequest_T	lockRequest = `Cpl::Dm::ModelPoint::eNO_REQUEST`
	)

protectedvirtualnoexcept

The caller can write a subset of array starting from the specified index in the Model Point's array.

Note: if dstIndex + srcNumElements exceeds the size of the MP's data then the write operation will be truncated

NOTE: The application/caller is responsible for what a 'partial write' means to the integrity of the MP's data. WARNING: Think before doing a partial write! For example, if the MP is in the invalid state and a partial write is done - then the MP's data/array is only partially initialized AND then MP is now in the valid state!

Member Data Documentation

◆ m_elementSize

size_t Cpl::Dm::Mp::ArrayBase_::m_elementSize

protected

Size, in bytes, of an element.

◆ m_numElements

size_t Cpl::Dm::Mp::ArrayBase_::m_numElements

protected

Number of elements in the array.

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

Cpl/Dm/Mp/Array.h

Detailed Description

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Class Documentation

◆ Cpl::Dm::Mp::ArrayBase_::MetaData_T

Constructor & Destructor Documentation

◆ ArrayBase_() [1/2]

◆ ArrayBase_() [2/2]

Member Function Documentation

◆ copyArrayFrom()

◆ copyDataFrom_()

◆ copyDataTo_()

◆ exportMetadata_()

◆ getInternalDataSize_()

◆ getNumElements()

◆ importMetadata_()

◆ isDataEqual_()

◆ readArrayElements()

◆ writeArrayElements()

Member Data Documentation

◆ m_elementSize

◆ m_numElements