This mostly concrete class provides the base implementation for a Point who's data is a null terminated string. More...

Detailed Description

This mostly concrete class provides the base implementation for a Point who's data is a null terminated string.

The concrete child class is responsible for providing the string storage and the attach/detach methods.

The toJSON()/fromJSON format is:

{ name:"<mpname>", type:"<mptypestring>", valid:true|false seqnum:nnnn, locked:true|false, val:{maxLen:<len>,text:"<newvalue>" }

NOTE: All methods in this class ARE thread Safe unless explicitly documented otherwise.

NOTE: The MP's null terminator for the string storage IS imported/exported.

#include <String.h>

Inheritance diagram for Cpl::Dm::Mp::StringBase_:

[legend]

Collaboration diagram for Cpl::Dm::Mp::StringBase_:

[legend]

Public Member Functions
bool	read (Cpl::Text::String &dstData, uint16_t *seqNumPtr=0) const noexcept
	Type safe read. See Cpl::Dm::ModelPoint.

bool	read (char dstData, size_t dataSizeInBytesIncludingNullTerminator, uint16_t seqNumPtr=0) const noexcept
	Type safe read. See Cpl::Dm::ModelPoint.

uint16_t	write (const char *srcNullTerminatedString, LockRequest_T lockRequest=eNO_REQUEST) noexcept
	Type safe write of a null terminated string. See Cpl::Dm::ModelPoint.

uint16_t	write (const char *srcData, size_t dataSizeInBytesIncludingNullTerminator, LockRequest_T lockRequest=eNO_REQUEST) noexcept
	Same as write(), except only writes at most 'srcLen' bytes.

size_t	getMaxLength () const noexcept
	Returns the maximum size WITHOUT the null terminator of the string storage.

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

const char *	getTypeAsText () const noexcept
	See Cpl::Dm::ModelPoint.

bool	fromJSON_ (JsonVariant &src, LockRequest_T lockRequest, uint16_t &retSequenceNumber, Cpl::Text::String *errorMsg) noexcept
	See Cpl::Dm::Point.

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

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
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	exportMetadata_ (void *dstDataStream, size_t &bytesAdded) const noexcept
	This method has PACKAGE Scope, i.e.

virtual bool	importMetadata_ (const void *srcDataStream, size_t &bytesConsumed) noexcept
	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
	StringBase_ (Cpl::Dm::ModelDatabase &myModelBase, const char symbolicName, char myDataPtr, size_t dataSizeInBytesIncludingNullTerminator)
	Constructor.

	StringBase_ (Cpl::Dm::ModelDatabase &myModelBase, const char symbolicName, char myDataPtr, size_t dataSizeInBytesIncludingNullTerminator, const char *initialValue)
	Constructor. Valid MP. Requires an initial value.

void	setJSONVal (JsonDocument &doc) noexcept
	See Cpl::Dm::Point.

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.

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::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.

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.

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

Constructor & Destructor Documentation

◆ StringBase_() [1/2]

Cpl::Dm::Mp::StringBase_::StringBase_	(	Cpl::Dm::ModelDatabase &	myModelBase,
		const char *	symbolicName,
		char *	myDataPtr,
		size_t	dataSizeInBytesIncludingNullTerminator
	)

protected

Constructor.

Invalid MP.

◆ StringBase_() [2/2]

Cpl::Dm::Mp::StringBase_::StringBase_	(	Cpl::Dm::ModelDatabase &	myModelBase,
		const char *	symbolicName,
		char *	myDataPtr,
		size_t	dataSizeInBytesIncludingNullTerminator,
		const char *	initialValue
	)

protected

Constructor. Valid MP. Requires an initial value.

Member Function Documentation

◆ copyFrom()

uint16_t Cpl::Dm::Mp::StringBase_::copyFrom	(	const StringBase_ &	src,
		LockRequest_T	lockRequest = `eNO_REQUEST`
	)

noexcept

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

◆ fromJSON_()

bool Cpl::Dm::Mp::StringBase_::fromJSON_	(	JsonVariant &	src,
		LockRequest_T	lockRequest,
		uint16_t &	retSequenceNumber,
		Cpl::Text::String *	errorMsg
	)

virtualnoexcept

See Cpl::Dm::Point.

Implements Cpl::Dm::ModelPoint.

◆ getMaxLength()

size_t Cpl::Dm::Mp::StringBase_::getMaxLength ( ) const

inlinenoexcept

Returns the maximum size WITHOUT the null terminator of the string storage.

◆ getTypeAsText()

const char * Cpl::Dm::Mp::StringBase_::getTypeAsText ( ) const

inlinevirtualnoexcept

See Cpl::Dm::ModelPoint.

Implements Cpl::Dm::ModelPoint.

◆ isDataEqual_()

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

virtualnoexcept

See Cpl::Dm::Point.

Reimplemented from Cpl::Dm::ModelPointCommon_.

◆ read() [1/2]

bool Cpl::Dm::Mp::StringBase_::read	(	char *	dstData,
		size_t	dataSizeInBytesIncludingNullTerminator,
		uint16_t *	seqNumPtr = `0`
	)		const

noexcept

Type safe read. See Cpl::Dm::ModelPoint.

◆ read() [2/2]

bool Cpl::Dm::Mp::StringBase_::read	(	Cpl::Text::String &	dstData,
		uint16_t *	seqNumPtr = `0`
	)		const

noexcept

Type safe read. See Cpl::Dm::ModelPoint.

◆ setJSONVal()

void Cpl::Dm::Mp::StringBase_::setJSONVal ( JsonDocument & doc )

protectedvirtualnoexcept

See Cpl::Dm::Point.

Implements Cpl::Dm::ModelPoint.

◆ write() [1/2]

uint16_t Cpl::Dm::Mp::StringBase_::write	(	const char *	srcData,
		size_t	dataSizeInBytesIncludingNullTerminator,
		LockRequest_T	lockRequest = `eNO_REQUEST`
	)

noexcept

Same as write(), except only writes at most 'srcLen' bytes.

◆ write() [2/2]

uint16_t Cpl::Dm::Mp::StringBase_::write	(	const char *	srcNullTerminatedString,
		LockRequest_T	lockRequest = `eNO_REQUEST`
	)

inlinenoexcept

Type safe write of a null terminated string. See Cpl::Dm::ModelPoint.

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

Cpl/Dm/Mp/String.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ StringBase_() [1/2]

◆ StringBase_() [2/2]

Member Function Documentation

◆ copyFrom()

◆ fromJSON_()

◆ getMaxLength()

◆ getTypeAsText()

◆ isDataEqual_()

◆ read() [1/2]

◆ read() [2/2]

◆ setJSONVal()

◆ write() [1/2]

◆ write() [2/2]