sfs3::entities::SFSUserVariable Class Reference

The standard implementation of UserVariable. More...

#include <SFSUserVariable.h>

Inheritance diagram for sfs3::entities::SFSUserVariable:

Public Member Functions
bool	isPrivate () override
	Indicates whether this User Variable is private or not.
std::string	toString () override
Public Member Functions inherited from sfs3::entities::Variable
std::string	name ()
virtual const VarData &	value ()
	Returns the value of this variable, whatever its type.
virtual std::optional< bool >	boolValue ()
virtual std::optional< uint8_t >	byteValue ()
virtual std::optional< int16_t >	shortValue ()
virtual std::optional< int32_t >	intValue ()
virtual std::optional< int64_t >	longValue ()
virtual std::optional< float >	floatValue ()
virtual std::optional< double >	doubleValue ()
virtual std::optional< std::string >	stringValue ()
virtual std::shared_ptr< SFSObject >	sfsObjectValue ()
virtual std::shared_ptr< SFSArray >	sfsArrayValue ()
virtual std::optional< SFSVector2 >	vector2Value ()
virtual std::optional< SFSVector3 >	vector3Value ()
virtual void	setNull ()
	Clears the value of this variable.
virtual void	setValue (VarData value)
	Sets the value of this variable.
virtual bool	isNull ()

Detailed Description

The standard implementation of UserVariable.

See also

UserVariable

requests::SetUserVariablesRequest

Member Function Documentation

isPrivate()

bool sfs3::entities::SFSUserVariable::isPrivate ( )

overridevirtual

Indicates whether this User Variable is private or not.

A private User Variable is visible only to its owner; any changes made to the variable will be transmitted to the owner only.

NOTE: setting this flag by hand on a User Variable returned by the API has no effect on the server and can disrupt the working of the API. You can set it only on a User Variable you create yourself.

Returns

whether or not the variable is private

Implements sfs3::entities::UserVariable.

toString()

std::string sfs3::entities::SFSUserVariable::toString ( )

overridevirtual

Returns

the name, the type and the value of this variable as text, for logging and debugging

Reimplemented from sfs3::entities::Variable.

---

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

• entities/SFSUserVariable.h
• entities/SFSUserVariable.cpp