IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::DeviceProp Class Reference

Data class stored for provisioning of Device properties which includes properties of WiFiConf resource and DevConf resource. More...

Public Member Functions

 DeviceProp ()
 Constructor. More...
 
 DeviceProp (const DeviceProp &deviceProp)
 
 DeviceProp (const DeviceProp &&deviceProp)
 
 DeviceProp (const OCRepresentation &rep)
 Constructor with OCRepresentation object. More...
 
void setWiFiProp (string ssid, string pwd, WIFI_AUTHTYPE authtype, WIFI_ENCTYPE enctype)
 Set WiFiConf resource properties to be delivered to Enrollee. More...
 
std::string getSsid () const
 Get a SSID of Enroller. More...
 
std::string getPassword () const
 Get a password of Enroller. More...
 
WIFI_AUTHTYPE getAuthType () const
 Get an auth type of Enroller. More...
 
WIFI_ENCTYPE getEncType () const
 Get an encryption type of Enroller. More...
 
const OCRepresentationtoOCRepresentation () const
 Get OCRepresentation object. More...
 
void updateOCRepresentation (int specVersion)
 Update Device and Wi-Fi representation as per OCF Specification. More...
 

Protected Attributes

OCRepresentation m_rep
 

Detailed Description

Data class stored for provisioning of Device properties which includes properties of WiFiConf resource and DevConf resource.

Constructor & Destructor Documentation

OIC::Service::DeviceProp::DeviceProp ( )
inline

Constructor.

OIC::Service::DeviceProp::DeviceProp ( const DeviceProp deviceProp)
inline
OIC::Service::DeviceProp::DeviceProp ( const DeviceProp &&  deviceProp)
inline
OIC::Service::DeviceProp::DeviceProp ( const OCRepresentation rep)
inline

Constructor with OCRepresentation object.

This is used for JNI communication.

Parameters
repOCRepresentation object

Member Function Documentation

WIFI_AUTHTYPE OIC::Service::DeviceProp::getAuthType ( ) const
inline

Get an auth type of Enroller.

Returns
an auth type of enroller
See Also
WIFI_AUTHTYPE

TODO: Recheck logic if this API is used.

WIFI_ENCTYPE OIC::Service::DeviceProp::getEncType ( ) const
inline

Get an encryption type of Enroller.

Returns
an encryption type of enroller
See Also
WIFI_ENCTYPE

TODO: Recheck logic if this API is used.

std::string OIC::Service::DeviceProp::getPassword ( ) const
inline

Get a password of Enroller.

Returns
a password of enroller
std::string OIC::Service::DeviceProp::getSsid ( ) const
inline

Get a SSID of Enroller.

Returns
a SSID of enroller
void OIC::Service::DeviceProp::setWiFiProp ( string  ssid,
string  pwd,
WIFI_AUTHTYPE  authtype,
WIFI_ENCTYPE  enctype 
)
inline

Set WiFiConf resource properties to be delivered to Enrollee.

Parameters
ssidSSID of the Enroller
pwdPassword of the Enroller
authtypeAuth type of the Enroller
enctypeEncryption type of the Enroller
See Also
WIFI_AUTHTYPE
WIFI_ENCTYPE
const OCRepresentation& OIC::Service::DeviceProp::toOCRepresentation ( ) const
inline

Get OCRepresentation object.

Returns
OCRepresentation object
void OIC::Service::DeviceProp::updateOCRepresentation ( int  specVersion)
inline

Update Device and Wi-Fi representation as per OCF Specification.

Resource Schema for WiFiConf resource is different in older Enrollee following OIC Spec compared to newer Enrollee following OCF Spec. This function updates the representation as per spec version.

Member Data Documentation

OCRepresentation OIC::Service::DeviceProp::m_rep
protected

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