class WifiConfiguration

Member values

Member name	Data type	Description
ssid	Ssid	SSID
security_key	string	Security key to used when connecting to Wi-Fi network
connect_automatically	bool	Connection mode. Set to true so robot automatically connects to this Wi-Fi network at bootup, false otherwise

Member functions

Function name	Return type	Input type	Description
has_ssid() const	bool	void	Returns true if ssid is set.
ssid()	const Ssid&	void	Returns the current value of ssid. If ssid is not set, returns a Ssid with none of its fields set (possibly ssid::default_instance()).
mutable_ssid()	Ssid *	void	Returns a pointer to the mutable Ssid object that stores the field's value. If the field was not set prior to the call, then the returned Ssid will have none of its fields set (i.e. it will be identical to a newly-allocated Ssid). After calling this, has_ssid() will return true and ssid() will return a reference to the same instance of Ssid.
clear_ssid()	void	void	Clears the value of the field. After calling this, has_ssid() will return false and ssid() will return the default value.
set_allocated_ssid()	void	Ssid *	Sets the Ssid object to the field and frees the previous field value if it exists. If the Ssid pointer is not NULL, the message takes ownership of the allocated Ssid object and has_ Ssid() will return true. Otherwise, if the ssid is NULL, the behavior is the same as calling clear_ssid().
release_ssid()	Ssid *	void	Releases the ownership of the field and returns the pointer of the Ssid object. After calling this, caller takes the ownership of the allocated Ssid object, has_ssid() will return false, and ssid() will return the default value.
security_key()	const string&	void	Returns the current value of security_key. If security_key is not set, returns the empty string/empty bytes.
set_security_key()	void	const string&	Sets the value of security_key. After calling this, security_key() will return a copy of value.
set_security_key()	void	string&&	(C++11 and beyond): Sets the value of security_key, moving from the passed string. After calling this, security_key() will return a copy of value.
set_security_key()	void	const char*	Sets the value of security_key using a C-style null-terminated string. After calling this, security_key() will return a copy of value.
mutable_security_key()	string *	void	Returns a pointer to the mutable string object that stores security_key's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, security_key() will return whatever value is written into the given string.
clear_security_key()	void	void	Clears the value of security_key. After calling this, security_key() will return the empty string/empty bytes.
set_allocated_security_key()	void	string*	Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_security_key().
release_security_key()	string *	void	Releases the ownership of security_key and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and security_key() will return the empty string/empty bytes.
connect_automatically()	bool	void	Returns the current value of connect_automatically. If the connect_automatically is not set, returns 0.
set_connect_automatically()	void	bool	Sets the value of connect_automatically. After calling this, connect_automatically() will return value.
clear_connect_automatically()	void	void	Clears the value of connect_automatically. After calling this, connect_automatically() will return 0.

Parent topic: Base (C++)