ph::SdlInputClause Class Reference

Carries SDL representation of various data during the input process. Helps to read input data such as command clauses or data packets. More...

#include <SdlInputClause.h>

Public Member Functions
	SdlInputClause ()=default
	SdlInputClause (std::string value)
	SdlInputClause (std::string value, std::string tag)
	SdlInputClause (std::string type, std::string name, std::string value)
	SdlInputClause (std::string type, std::string name, std::string value, std::string tag)
bool	isResourceIdentifier () const
	Helper to check if the carried value is a SDL resource identifier (SRI).
std::string	genPrettyName () const
std::string	toString () const

Public Attributes
std::string	type
std::string	name
std::string	value
	Loaded stringified data of a clause. All potential SDL value prefixes or suffixes (e.g., "" or {}) are already removed for convenience. If the value contains a single named target, its corresponding specifier (e.g., "@", "$") will be removed, see valueType.].
std::string	tag
ESdlClauseValue	valueType = ESdlClauseValue::General
	Type of the carried value. For identifying the type of the value string only. Does not check whether the value has valid format or points to a valid target.

Detailed Description

Carries SDL representation of various data during the input process. Helps to read input data such as command clauses or data packets.

Constructor & Destructor Documentation

SdlInputClause() [1/5]

ph::SdlInputClause::SdlInputClause ( )

default

SdlInputClause() [2/5]

ph::SdlInputClause::SdlInputClause ( std::string value )

inlineexplicit

SdlInputClause() [3/5]

ph::SdlInputClause::SdlInputClause ( std::string value, std::string tag )

inline

SdlInputClause() [4/5]

ph::SdlInputClause::SdlInputClause ( std::string type, std::string name, std::string value )

inline

SdlInputClause() [5/5]

ph::SdlInputClause::SdlInputClause ( std::string type, std::string name, std::string value, std::string tag )

inline

Member Function Documentation

genPrettyName()

std::string ph::SdlInputClause::genPrettyName ( ) const

inline

isResourceIdentifier()

bool ph::SdlInputClause::isResourceIdentifier

(

)

const

Helper to check if the carried value is a SDL resource identifier (SRI).

toString()

std::string ph::SdlInputClause::toString ( ) const

inline

Member Data Documentation

name

std::string ph::SdlInputClause::name

tag

std::string ph::SdlInputClause::tag

type

std::string ph::SdlInputClause::type

value

std::string ph::SdlInputClause::value

Loaded stringified data of a clause. All potential SDL value prefixes or suffixes (e.g., "" or {}) are already removed for convenience. If the value contains a single named target, its corresponding specifier (e.g., "@", "$") will be removed, see valueType.].

valueType

ESdlClauseValue ph::SdlInputClause::valueType = ESdlClauseValue::General

Type of the carried value. For identifying the type of the value string only. Does not check whether the value has valid format or points to a valid target.

---

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

• Source/SDL/SdlInputClause.h
• Source/SDL/SdlInputClause.cpp