mvIMPACT Acquire SDK C++
UserDataEntry Class Reference

A helper class that represents one entry in the devices non-volatile memory. More...

Public Member Functions

bool isValid (void) const
 Call this function to check if this object references an existing entry. More...
 

Public Attributes

PropertyIUserDataAccessRight access
 The access rights for this entry. More...
 
PropertyS data
 The data stored in this entry. More...
 
PropertyS name
 The name of the entry. More...
 
PropertyS password
 The password needed to modify this entry. More...
 

Friends

class UserData
 

Detailed Description

A helper class that represents one entry in the devices non-volatile memory.

(if available).

Each entry of user and device specific data consists of a name, data a property defining the access rights for this entry and an optional password.

The name can be any string, but currently is limited to 255 characters.

The mvIMPACT::acquire::UserDataEntry::data property can hold any type of user data that shall be stored in the device's non-volatile memory. This can either be a string or binary data. To store binary data the function mvIMPACT::acquire::PropertyS::writeBinary can be used. Internally however binary data will be stored as a Base64 encoded string. To read binary data from the property again the function mvIMPACT::acquire::PropertyS::readBinary must be called. The theoretical limit for the amount of data per entry is 2^16 (64KB) bytes, however the real limit might be below this value because the device does not offer that much memory.

The mvIMPACT::acquire::UserDataEntry::access property defines the access rights the user has when working with the entry. AFTER creation but BEFORE storing the entry into the device this property can be modified. At this point the creator of the entry can choose between 2 options: mvIMPACT::acquire::udarFull and mvIMPACT::acquire::udarRW. After storing the entry into the device by calling mvIMPACT::acquire::UserData::writeToHardware this property will become read-only and will remain read-only until the complete entry is deleted.

When the user creates a new entry for the user accessible device non-volatile memory he can either create a read/write data set, which means that every user can modify the data and the name property. In that case the property password is ignored. Apart from that an entry that can only be modified when the correct password has been written to the password property. To read a value is always allowed.

The password property will hold the user input and NOT the actual password needed to unlock the data set. However when an entry has been created the creator afterwards can write to the password. When the creator then calls the function mvIMPACT::acquire::UserData::writeToHardware the value of the password property is used as the 'real' password from that moment onwards.

The maximum length for the password currently is 255 characters. This does not provide total security of cause, but the idea of the password only is to hinder the user from deleting an import entry by accident.

The memory consumed by a single mvIMPACT::acquire::UserDataEntry can vary from device to device and depends on the way the data is stored internally. In any case when an entry is created it will consume more memory than the amount of bytes written to the mvIMPACT::acquire::UserDataEntry::data. After data has been written to an entry it is therefore important to check the mvIMPACT::acquire::UserData::memoryAvailable_bytes property if there is still enough memory available.

Note
There might be entries that can't be modified by the user. These entries contain important data that have been written to the memory during production. An attempt to delete this data will fail.
//-----------------------------------------------------------------------------
int storeUserData( Device* pDev, char* pData, size_t dataSize, const std::string& entryName )
//-----------------------------------------------------------------------------
{
UserData& userData = pDev->getUserData();
if( !userData.isAvailable() )
{
cout << "This device does not support user data" << endl;
return -1;
}
cout << "Available user memory(bytes): " << userData.memoryAvailable_bytes.read() << endl;
cout << "Memory consumed already(bytes): " << userData.memoryConsumed_bytes.read() << endl;
// create a new entry
UserDataEntry entry = userData.createEntry();
if( !entry.isValid() )
{
cout << "Failed to create new entry" << endl;
return -2;
}
string value( pData, dataSize );
entry.data.writeBinary( value );
entry.name.write( entryName );
// write to non-volatile memory (therefore the device MUST be closed)
if( pDev->isOpen() )
{
cout << "Can't store data as the device is already in use" << endl;
return -3;
}
userData.writeToHardware();
if( pDev->HWUpdateResult.read() != urSetUserDataWriteOK )
{
cout << "Failed to store data in device non-volatile memory" << endl;
return -4;
}
// now this data is stored in the devices permanent memory
return 0;
}
friend class UserData
Definition: mvIMPACT_acquire.h:5578
@ urSetUserDataWriteOK
Writing user data to mvIMPACT::acquire::Device was successful.
Definition: mvDriverBaseEnums.h:2931
Note
Instances of this class can only be created by the class UserData.

Member Function Documentation

◆ isValid()

bool isValid ( void  ) const
inline

Call this function to check if this object references an existing entry.

Returns
  • true if this object references an existing entry
  • false otherwise

Friends And Related Function Documentation

◆ UserData

friend class UserData
friend

Member Data Documentation

◆ access

The access rights for this entry.

After this entry has been written to the devices non-volatile memory, this property will become read-only.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TUserDataAccessRight.

◆ data

PropertyS data

The data stored in this entry.

The theoretical limit for the amount of data per entry is 2^16 (64KB) bytes, however the real limit might be below this value because the device does not offer that much memory.

This property can either store string or binary data. See mvIMPACT::acquire::PropertyS to find out how to work with binary data.

◆ name

PropertyS name

The name of the entry.

The maximum length for the name currently is 255 characters.

◆ password

PropertyS password

The password needed to modify this entry.

The maximum length for the password is 255 characters currently. When the mvIMPACT::acquire::udarPassword is not specified by the access property, this property will be ignored. Otherwise this property must have been assigned the correct password (case sensitive) before the name and data properties can be modified.


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