This mostly abstract class defines the interface for a Model Point. More...

Detailed Description

This mostly abstract class defines the interface for a Model Point.

A Model Point contains an instance of a Point's data and is responsible for managing thread safe access to the 'Point'. The intent of a Model point is that it is the Application's canonical source for a 'Point'

NOTES: 1) The concrete leaf classes are responsible for ensuring type safety. 2) All methods are atomic, i.e. a protected by the Model Base's mutex. This means that all methods will block if there is a call in-progress to ANY Model Point in a given Model Data Base. 3) All methods in this class ARE thread Safe unless explicitly documented otherwise.

#include <ModelPoint.h>

Inheritance diagram for Cpl::Dm::ModelPoint:

[legend]

Collaboration diagram for Cpl::Dm::ModelPoint:

[legend]

Public Types
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...

Public Member Functions
virtual const char *	getName () const noexcept=0
	This method returns the Model Point's name as a null terminated string.

virtual uint16_t	getSequenceNumber () const noexcept=0
	This method returns the Model Point's current sequence number.

virtual uint16_t	touch () noexcept=0
	This method does NOT alter the MP's data or state, but unconditionally triggers the MP change notification(s).

virtual size_t	getSize () const noexcept=0
	This method returns the RAM size, in bytes, of the Model Point's data.

virtual bool	isNotValid (uint16_t *seqNumPtr=0) const noexcept=0
	This method returns true when the MP data is invalid.

virtual uint16_t	setInvalid (LockRequest_T lockRequest=eNO_REQUEST) noexcept=0
	This method is used to mark the element's data as invalid.

virtual bool	toJSON (char *dst, size_t dstSize, bool &truncated, bool verbose=true, bool pretty=false) noexcept=0
	This method converts the Model Point's data to JSON string and copies the resultant string into 'dst'.

virtual const char *	getTypeAsText () const noexcept=0
	This method returns a string identifier for the Model Point's data type.

virtual bool	isLocked () const noexcept=0
	This method returns true if the Model Point is in the locked state.

virtual uint16_t	setLockState (LockRequest_T lockRequest) noexcept=0
	This updates the lock state of the Model Point.

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 size_t	exportData (void dstDataStream, size_t maxDstLength, uint16_t retSequenceNumber=0, bool includeLockedState=false) const noexcept=0
	This method is used to export the Model Point's instance data content to a raw data stream.

virtual size_t	importData (const void srcDataStream, size_t srcLength, uint16_t retSequenceNumber=0, bool includeLockedState=false) noexcept=0
	This method is used to populate the Model Point's data content from the a raw data stream/pointer.

virtual size_t	getExternalSize (bool includeLockedState=false) const =0
	Returns the size, in bytes, of the element's data content.

virtual void	genericAttach (SubscriberApi &observer, uint16_t initialSeqNumber=SEQUENCE_NUMBER_UNKNOWN) noexcept=0
	This method is used to subscribe to on-change notification in a GENERIC manner.

virtual void	genericDetach (SubscriberApi &observer) noexcept=0
	This is method is used to detach a GENERIC Subscriber from a Model Point.

virtual void	processSubscriptionEvent_ (SubscriberApi &subscriber, Event_T event) noexcept=0
	This method has PACKAGE Scope, i.e.

virtual void	copyDataFrom_ (const void *srcData, size_t srcSize) noexcept=0
	This method has PACKAGE Scope, i.e.

virtual void	copyDataTo_ (void *dstData, size_t dstSize) const noexcept=0
	This method has PACKAGE Scope, i.e.

virtual bool	isDataEqual_ (const void *otherData) const noexcept=0
	This method has PACKAGE Scope, i.e.

virtual const void *	getImportExportDataPointer_ () const noexcept=0
	This method has PACKAGE Scope, i.e.

virtual size_t	getInternalDataSize_ () const noexcept=0
	This method has PACKAGE Scope, i.e.

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

Static Public Attributes
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 Member Functions
virtual bool	readData (void dstData, size_t dstSize, uint16_t seqNumPtr=0) const noexcept=0
	This method copies the Model Point's content to the caller's Point instance.

virtual uint16_t	writeData (const void *srcData, size_t srcSize, LockRequest_T lockRequest=eNO_REQUEST) noexcept=0
	This method writes the caller Point instance to the Model Point's internal data.

virtual void	attachSubscriber (SubscriberApi &observer, uint16_t initialSeqNumber=SEQUENCE_NUMBER_UNKNOWN) noexcept=0
	This method is used to attach a subscriber to a Model Point.

virtual void	detachSubscriber (SubscriberApi &observer) noexcept=0
	This method is used to detach a Subscriber from a Model Point.

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.

Additional Inherited Members
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.

Member Enumeration Documentation

◆ Event_T

enum Cpl::Dm::ModelPoint::Event_T

Subscriber events.

Enumerator
eATTACH	The Application is requesting to subscribe to a model point.
eDETACH	The Application is requesting to un-subscribe from the model point.
eDATA_CHANGED	The model point's data/state has change a pending change notification is needed.
eNOTIFYING	The subscriber's change notification callback is being called.
eNOTIFY_COMPLETE	The subscriber's change notification callback has been completed.

◆ LockRequest_T

enum Cpl::Dm::ModelPoint::LockRequest_T

Options related to the Model Point's locked state.

Enumerator

eNO_REQUEST

No change in the MP's lock state is requested.

eLOCK

Request to lock the MP.

If the MP is already lock - the request is ignored and the update operation silent fails

eUNLOCK

Request to unlock the MP.

If the MP is already unlocked - the request is ignored and the update operation is completed

Constructor & Destructor Documentation

◆ ~ModelPoint()

virtual Cpl::Dm::ModelPoint::~ModelPoint ( )

inlinevirtual

Virtual destructor to make the compiler happy.

Member Function Documentation

◆ applyLock()

uint16_t Cpl::Dm::ModelPoint::applyLock ( )

inlinenoexcept

Short hand for putting the MP into the locked state.

◆ attachSubscriber()

virtual void Cpl::Dm::ModelPoint::attachSubscriber	(	SubscriberApi &	observer,
		uint16_t	initialSeqNumber = `SEQUENCE_NUMBER_UNKNOWN`
	)

protectedpure virtualnoexcept

This method is used to attach a subscriber to a Model Point.

Once attached the Subscriber will receive a change notification (aka a callback) every time the Model Point's data/state changes. Once, a Subscriber is attached - it will stay attached to the application calls detach().

There is no limit to the number of Subscribers that can attach to a Model Point.

The attach() method can be called even if the Subscriber is already attached. When this happens, the attach process is 'restarted', i.e. the 'initialSeqNumber' is used for the Subscriber's sequence number.

The change-detect mechanism uses a sequence number. Each Model Point and each Subscriber has sequence number. When the Subscriber's sequence number does not equals the Model Point's sequence number - the Subscriber receives a change notification and the Subscriber's sequence number is updated to match the Model Point's sequence number at the time of change notification. When a Subscriber attaches to Model Point with an the 'seqNumber' argument set to SEQUENCE_NUMBER_UNKNOWN, the Subscriber will get an 'immediate' change notification.

The callbacks for the Change Notifications are called as part of the Data Model's Mailbox server. As part of the asynchronous processing (timers, ITC, EventFlags, etc.) of the Data Model Mailbox server will also process all pending Change Notification and invoke the call backs. What does that all mean? The Change notifications are "local" to the Subscriber's thread very similar to how the Cpl::Timers work. It also means that no change notification callback will be called till the Mailbox server loops back to the "top" of its forever loop.

NOTE: The Change Notification mechanism does NOT guarantee that a client will receive a notification for EVERY change to a Model Point (i.e. 'fast edges' could/will be missed). What is guaranteed is that once a Model Point's value has 'settle' all registered subscribers will have received change notification for the Model Point's current value.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ copyDataFrom_()

virtual void Cpl::Dm::ModelPoint::copyDataFrom_	(	const void *	srcData,
		size_t	srcSize
	)

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used to unconditionally update the Model Point's data.

This method is NOT Thread Safe.

Notes: 1) The assumption is that Model Point Data instance and 'src' are the of the same type. 2) The internal data size of the Model Point instance is ALWAYS honored when coping the data from 'src' 3) The Model Point's sequence number is not changed.

Implemented in Cpl::Dm::ModelPointCommon_, and Cpl::Dm::Mp::ArrayBase_.

◆ copyDataTo_()

virtual void Cpl::Dm::ModelPoint::copyDataTo_	(	void *	dstData,
		size_t	dstSize
	)		const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used update's the caller's 'Point Data' with the Model Point's data.

This method is NOT Thread Safe.

Notes: 1) The assumption is that Model Point Data instance and 'dst' are the of the same type. 2) The 'dstSize' of the destination ALWAYS honored when coping the Model Point's data to 'dst' 3) The Model Point's sequence number is not changed.

Implemented in Cpl::Dm::ModelPointCommon_, and Cpl::Dm::Mp::ArrayBase_.

◆ detachSubscriber()

virtual void Cpl::Dm::ModelPoint::detachSubscriber ( SubscriberApi & observer )

protectedpure virtualnoexcept

This method is used to detach a Subscriber from a Model Point.

See the attach() method for more details about the Subscription/Change Notification mechanism.

The detach() method can be called even if the Subscriber is NOT currently attached. The detach() method can be called within the Change Notification callback.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ exportData()

virtual size_t Cpl::Dm::ModelPoint::exportData	(	void *	dstDataStream,
		size_t	maxDstLength,
		uint16_t *	retSequenceNumber = `0`,
		bool	includeLockedState = `false`
	)		const

pure virtualnoexcept

This method is used to export the Model Point's instance data content to a raw data stream.

It is the responsibility of the caller to ensure that there is sufficient memory available for the data being exported. The method returns the number of bytes exported.

When the 'includeLockedState' argument is set to true, the method export's the MP's locked state (in addition to the MP's value and valid state).

If the number of returns bytes equals zero then the export operation encountered an error.

The method optionally return the Model Point's sequence number at the time of the export.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ exportMetadata_()

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

inlinevirtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is NOT Thread Safe.

This method is used to export meta data when exporting a model point. If there is error in exporting the metadata false is returned; else true is returned.

A default implementation is provided that always returns true, i.e. for model points that do not have metadata.

NOTE: The overall size of the destination has been validated with respect holding both the Model Point's metadata and the data - so the no 'dstLength' argument is passed/provided.

Reimplemented in Cpl::Dm::Mp::ArrayBase_.

◆ fromJSON_()

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

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method attempts to convert JSON object 'src' to its binary format and copies the result to the Model Point's internal data. The expected format of the JSON string is specific to the concrete leaf class.

See Cpl::Dm::ModelDatabaseApi::fromJSON() method for JSON format.

◆ genericAttach()

virtual void Cpl::Dm::ModelPoint::genericAttach	(	SubscriberApi &	observer,
		uint16_t	initialSeqNumber = `SEQUENCE_NUMBER_UNKNOWN`
	)

pure virtualnoexcept

This method is used to subscribe to on-change notification in a GENERIC manner.

This means the on-change callback notification WILL NOT be type specific. USE WITH CAUTION - using type specific callbacks is the preferred usage.

See the attach() method below for additional details of subscribing

Implemented in Cpl::Dm::ModelPointCommon_.

◆ genericDetach()

virtual void Cpl::Dm::ModelPoint::genericDetach ( SubscriberApi & observer )

pure virtualnoexcept

This is method is used to detach a GENERIC Subscriber from a Model Point.

See the detach() method below for additional details of subscribing

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getExternalSize()

virtual size_t Cpl::Dm::ModelPoint::getExternalSize ( bool includeLockedState = false ) const

pure virtual

Returns the size, in bytes, of the element's data content.

When 'includeLockedState is set to true, the 'externalSize' includes space for the MP's locked state; else the returned size only includes space for the MP's value and valid state..

NOTE: The size returned is the size of the Point data WHEN it is being exported/imported - this is NOT the value of the size of the Point's internal storage use for the data content.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getImportExportDataPointer_()

virtual const void * Cpl::Dm::ModelPoint::getImportExportDataPointer_ ( ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is NOT Thread Safe.

This method returns a pointer to the Model Point's data for Import/Export operations. BE VERY CAREFULL on how the pointer is used!

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getInternalDataSize_()

virtual size_t Cpl::Dm::ModelPoint::getInternalDataSize_ ( ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is NOT Thread Safe.

This method returns the "internal size" of the Model Point's data point. This length (when applicable) INCLUDES ANY 'META/EXTRA' DATA that is NOT the valid/locked meta-data - but is used with the internal import()/export() methods.

Implemented in Cpl::Dm::ModelPointCommon_, and Cpl::Dm::Mp::ArrayBase_.

◆ getName()

virtual const char * Cpl::Dm::ModelPoint::getName ( ) const

pure virtualnoexcept

This method returns the Model Point's name as a null terminated string.

Note: Model Point names are assumed to be unique. However, it is responsibility of the Application to enforce this constraint. If names are not unique then the look-up by Model Point name functionality will fail. No other functionality depends on have unique names.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getSequenceNumber()

virtual uint16_t Cpl::Dm::ModelPoint::getSequenceNumber ( ) const

pure virtualnoexcept

This method returns the Model Point's current sequence number.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getSize()

virtual size_t Cpl::Dm::ModelPoint::getSize ( ) const

pure virtualnoexcept

This method returns the RAM size, in bytes, of the Model Point's data.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ getTypeAsText()

virtual const char * Cpl::Dm::ModelPoint::getTypeAsText ( ) const

pure virtualnoexcept

This method returns a string identifier for the Model Point's data type.

This value IS GUARANTEED to be unique (within an Application). The format of the string is the Model Point's fully qualified namespace and class type as a string. For example, the for Cpl::Dm::Mp::Uint32 Model Point the function would return "Cpl::Dm::Mp::Uint32"

Note: The type string can contain additional information, but adding a '-' character followed by the extra info. For example: "Cpl::Dm::Mp::Uint32-hex"

◆ importData()

virtual size_t Cpl::Dm::ModelPoint::importData	(	const void *	srcDataStream,
		size_t	srcLength,
		uint16_t *	retSequenceNumber = `0`,
		bool	includeLockedState = `false`
	)

pure virtualnoexcept

This method is used to populate the Model Point's data content from the a raw data stream/pointer.

It is the responsibility of the caller to ensure that the data stream is appropriate for element type and that the data stream content was originally created by the corresponding export() method. The method returns the number of bytes consumed from the data stream.

When the 'includeLockedState' argument is set to true, the method imports's the MP's locked state (in addition to the MP's value and valid state).

If the number of returns bytes equals zero then the import operation encountered an error.

The method optionally return the Model Point's sequence number once the import has completed.

The method ALWAYS triggers a change notification(s) for the Model Point

Implemented in Cpl::Dm::ModelPointCommon_.

◆ importMetadata_()

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

inlinevirtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is NOT Thread Safe.

This method is used to import meta data when importing a model point. If the incoming meta data is 'not-valid/not-compatible' then false is returned and the import operation will fail; else true is returned.

A default implementation is provided that always returns true, i.e. for model points that do not have metadata

NOTE: The overall size of the source has been validated with respect containing both the Model Point's metadata and the data - so the no 'srcLength' argument is passed/provided.

Reimplemented in Cpl::Dm::Mp::ArrayBase_.

◆ isDataEqual_()

virtual bool Cpl::Dm::ModelPoint::isDataEqual_ ( const void * otherData ) const

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is NOT Thread Safe.

This method compares the Model Point's data to the data of 'other' Model Point and returns true if the data of both points are the same. It is assumed that Model Point instance and 'other' are the of the same leaf class type.

Implemented in Cpl::Dm::ModelPointCommon_, Cpl::Dm::Mp::ArrayBase_, Cpl::Dm::Mp::Double, Cpl::Dm::Mp::Float, and Cpl::Dm::Mp::StringBase_.

◆ isLocked()

virtual bool Cpl::Dm::ModelPoint::isLocked ( ) const

pure virtualnoexcept

This method returns true if the Model Point is in the locked state.

In the locked state - ALL WRITE/UPDATE OPERATIONS (except for changing the locked state) are silently ignored/dropped.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ isNotValid()

virtual bool Cpl::Dm::ModelPoint::isNotValid ( uint16_t * seqNumPtr = 0 ) const

pure virtualnoexcept

This method returns true when the MP data is invalid.

The method optionally returns the Point's sequence number via the argument 'seqNumPtr'.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ processSubscriptionEvent_()

virtual void Cpl::Dm::ModelPoint::processSubscriptionEvent_	(	SubscriberApi &	subscriber,
		Event_T	event
	)

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used by Model Point to process events related to the subscription/change-notification process

This method is Thread Safe

Implemented in Cpl::Dm::ModelPointCommon_.

◆ readData()

virtual bool Cpl::Dm::ModelPoint::readData	(	void *	dstData,
		size_t	dstSize,
		uint16_t *	seqNumPtr = `0`
	)		const

protectedpure virtualnoexcept

This method copies the Model Point's content to the caller's Point instance.

The method returns the Model Point's valid state. The MP's sequence number is optionally return if 'seqNumPtr' is set to a non-zero value.

If the method returns false then the MP's the data is invalid and the contents of 'dst' is meaningless.

Notes: 1) The assumption is that Model Point's internal data and 'dstData' are of the same type. 2) The data size of the 'dstSize' is ALWAYS honored when coping the data from the Model Point 3) The Model Point's sequence number is not changed.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ removeLock()

uint16_t Cpl::Dm::ModelPoint::removeLock ( )

inlinenoexcept

Short hand for unconditionally removing the lock from the MP.

◆ setInvalid()

virtual uint16_t Cpl::Dm::ModelPoint::setInvalid ( LockRequest_T lockRequest = eNO_REQUEST )

pure virtualnoexcept

This method is used to mark the element's data as invalid.

The method returns the Model Point's sequence number after updating the valid state.

Notes: 1) Any write operation will set the Model Point's state to valid. 2) Change Notification(s) will ONLY be triggered when there is valid to invalid state transition (i.e. if the Model Point is already in the invalid state - no change notification will be triggered). 3) If the Model Point is locked then the invalidate operation... a) If lockRequest == eNO_REQUEST, the operation silently fails, i.e. nothing is done. OR b) If lockRequest != eNO_REQUEST, the operation is performed and the the new lock state is applied

Implemented in Cpl::Dm::ModelPointCommon_.

◆ setJSONVal()

virtual void Cpl::Dm::ModelPoint::setJSONVal ( JsonDocument & doc )

protectedpure virtualnoexcept

This method converts the MP data to a JSON key/value pair.

The key must be 'val' This method is only called when the MP data is valid

◆ setLockState()

virtual uint16_t Cpl::Dm::ModelPoint::setLockState ( LockRequest_T lockRequest )

pure virtualnoexcept

This updates the lock state of the Model Point.

Model Points support the concept of a client 'locking' the MP's data value. When a MP's data has been locked - any attempted writes/updated operation to the MP will SILENTLY fail. The Application uses the 'eUNLOCK' lock request to remove the locked state from the MP's data.

This method never triggers change notification(s).

The method returns the MP's sequence number at the time of when then lock request was applied.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ toJSON()

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

pure virtualnoexcept

This method converts the Model Point's data to JSON string and copies the resultant string into 'dst'.

If the Model Point's data cannot be represented as a JSON object then the contents of 'dst' is set to an empty string and the method returns false; else the method returns true. The format of the string is specific to the concrete leaf class. However, it is strongly recommended that the output of this method be the same format that is expected for the fromJSON() method.

NOTE: If the converted string is larger than the memory allocated by 'dst' then the string result in 'dst' will be truncated. The caller is required to check 'truncated' flag for the truncated scenario.

The general output format:

{ name:"<mpname>", type:"<mptypestring>", valid:true|false, seqnum:nnnn, locked:true|false, val:<value> }
 
Notes:
    - The MP is in the valid state if/when the 'valid' value is true
    - The 'val' key/value pair is omitted if the MP is in the invalid state
    - The 'val' key/value pair can be a single element, an object, or
      array. etc. -- it is specific to the concrete MP type/class.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ touch()

virtual uint16_t Cpl::Dm::ModelPoint::touch ( )

pure virtualnoexcept

This method does NOT alter the MP's data or state, but unconditionally triggers the MP change notification(s).

The method returns the Model Point's sequence number after the method completes.

Implemented in Cpl::Dm::ModelPointCommon_.

◆ writeData()

virtual uint16_t Cpl::Dm::ModelPoint::writeData	(	const void *	srcData,
		size_t	srcSize,
		LockRequest_T	lockRequest = `eNO_REQUEST`
	)

protectedpure virtualnoexcept

This method writes the caller Point instance to the Model Point's internal data.

The method returns the Model Point's sequence number after the method completes.

Model Point supports the concept of a client 'locking' the MP's data value. When a MP's data has been locked - all attempted writes to the MP - with lockRequest == eNO_REQUEST - will SILENTLY fail. The Application uses the removeLock() method or the 'eUNLOCK' lock request to remove the locked state from the MP's data. The application can also updated the value of MP when it is locked state by setting lockRequest == eLOCK.

Notes: 1) The assumption is that Model Point's internal data and 'srcData' are of the same type. 2) The data size of the Model Points data instance is ALWAYS honored when coping the data from 'srcData'

Implemented in Cpl::Dm::ModelPointCommon_.

Member Data Documentation

◆ SEQUENCE_NUMBER_UNKNOWN

const uint16_t Cpl::Dm::ModelPoint::SEQUENCE_NUMBER_UNKNOWN

static

Magic value to use when registering for a change notification and application does not 'know' the current sequence number value of the Model Point.

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

Cpl/Dm/ModelPoint.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ Event_T

◆ LockRequest_T

Constructor & Destructor Documentation

◆ ~ModelPoint()

Member Function Documentation

◆ applyLock()

◆ attachSubscriber()

◆ copyDataFrom_()

◆ copyDataTo_()

◆ detachSubscriber()

◆ exportData()

◆ exportMetadata_()

◆ fromJSON_()

◆ genericAttach()

◆ genericDetach()

◆ getExternalSize()

◆ getImportExportDataPointer_()

◆ getInternalDataSize_()

◆ getName()

◆ getSequenceNumber()

◆ getSize()

◆ getTypeAsText()

◆ importData()

◆ importMetadata_()

◆ isDataEqual_()

◆ isLocked()

◆ isNotValid()

◆ processSubscriptionEvent_()

◆ readData()

◆ removeLock()

◆ setInvalid()

◆ setJSONVal()

◆ setLockState()

◆ toJSON()

◆ touch()

◆ writeData()

Member Data Documentation

◆ SEQUENCE_NUMBER_UNKNOWN