Phosphorus::IBaseParameter Class Reference

Represents parameter which can be serializable. Used by IParameter. More...

#include <GameObject.h>

Inheritance diagram for Phosphorus::IBaseParameter:

Public Member Functions
virtual int32	Write (nlohmann::json &target) const =0
	Writes text representation of data to JSON object.
virtual int32	Read (nlohmann::json &target)=0
	Parses text representation of data from JSON object.
virtual void	SetDisplayName (const String &name)=0
virtual String	GetName () const =0
	Returns parameter name.
virtual String	GetDisplayName () const =0
	Returns parameter display name.

Detailed Description

Represents parameter which can be serializable. Used by IParameter.

Member Function Documentation

GetDisplayName()

virtual String Phosphorus::IBaseParameter::GetDisplayName ( ) const

nodiscardpure virtual

Returns parameter display name.

Implemented in Phosphorus::IParameter< T >, Phosphorus::IParameter< int32 >, and Phosphorus::IParameter< String >.

GetName()

virtual String Phosphorus::IBaseParameter::GetName ( ) const

nodiscardpure virtual

Returns parameter name.

Implemented in Phosphorus::IParameter< T >, Phosphorus::IParameter< int32 >, and Phosphorus::IParameter< String >.

Read()

virtual int32 Phosphorus::IBaseParameter::Read ( nlohmann::json & target )

pure virtual

Parses text representation of data from JSON object.

Parameters

target

JSON object

Returns

int32 Bytes written

Implemented in Phosphorus::BaseEnumParameter, and Phosphorus::StringParameter.

Write()

virtual int32 Phosphorus::IBaseParameter::Write ( nlohmann::json & target ) const

pure virtual

Writes text representation of data to JSON object.

Parameters

target

JSON object

Returns

int32 Bytes written

Implemented in Phosphorus::BaseEnumParameter, and Phosphorus::StringParameter.

---

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

• phosphorus/GameObject.h