DeviceConfiguration Class Reference

Class for managing and serializing device details. More...

#include <deviceconfiguration.h>

Public Member Functions
	DeviceConfiguration ()
	DeviceConfiguration (std::string const &id, std::string const &name)
std::string	id () const
std::string	name () const
void	setName (std::string name)
std::string	serialize () const

Static Public Member Functions
static std::unique_ptr< DeviceConfiguration >	deserialize (const std::string &contents)

Private Attributes
std::string	id_
std::string	name_

Detailed Description

Class for managing and serializing device details.

Right now this includes the device identifier string (expected to be a UUID4) and the user-assigned device name.

This configuration is generated the first time a device is seen to ensure plptools has a way to uniquely identify it on future connections. This is particularly important for backups.

Definition at line 34 of file deviceconfiguration.h.

Constructor & Destructor Documentation

DeviceConfiguration() [1/2]

DeviceConfiguration::DeviceConfiguration

(

)

Definition at line 42 of file deviceconfiguration.cc.

DeviceConfiguration() [2/2]

DeviceConfiguration::DeviceConfiguration	(	std::string const &	id,
		std::string const &	name
	)

Definition at line 47 of file deviceconfiguration.cc.

Member Function Documentation

deserialize()

std::unique_ptr< DeviceConfiguration > DeviceConfiguration::deserialize ( const std::string &  contents )

static

Definition at line 31 of file deviceconfiguration.cc.

id()

std::string DeviceConfiguration::id ( ) const

inline

Definition at line 43 of file deviceconfiguration.h.

name()

std::string DeviceConfiguration::name ( ) const

inline

Definition at line 47 of file deviceconfiguration.h.

serialize()

std::string DeviceConfiguration::serialize

(

)

const

Definition at line 52 of file deviceconfiguration.cc.

setName()

void DeviceConfiguration::setName ( std::string  name )

inline

Definition at line 51 of file deviceconfiguration.h.

Member Data Documentation

id_

std::string DeviceConfiguration::id_

private

Definition at line 58 of file deviceconfiguration.h.

name_

std::string DeviceConfiguration::name_

private

Definition at line 59 of file deviceconfiguration.h.

---

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

• lib/deviceconfiguration.h
• lib/deviceconfiguration.cc