ph::SdlOutputClause Class Reference

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

#include <SdlOutputClause.h>

Public Member Functions
	SdlOutputClause ()=default
void	clear ()
bool	hasTag () const
std::string	toString () const

Public Attributes
std::string	type
std::string	name
	Stores a name for the data. May refer to some output clauses. See isUsingNamedOutputClauses.
std::string	value
	Stores stringified data of a clause. As the output clause generator knows best how its data look like, additional prefixes or suffixes may need to be added to ensure data integrity. For example, if a string contains whitespaces, double quotes should be used (e.g., " many spaces in data "); for an array of quoted elements, curly braces can be used (e.g, {"a", "b", "c"}).
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.
bool	isEmpty = false
	If the clause carries no data and does not need to be written.
bool	isUsingNamedOutputClauses = false
	If the carried name refers to some output clauses.

Detailed Description

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

Constructor & Destructor Documentation

SdlOutputClause()

ph::SdlOutputClause::SdlOutputClause ( )

default

Member Function Documentation

clear()

void ph::SdlOutputClause::clear ( )

inline

hasTag()

bool ph::SdlOutputClause::hasTag ( ) const

inline

toString()

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

inline

Member Data Documentation

isEmpty

bool ph::SdlOutputClause::isEmpty = false

If the clause carries no data and does not need to be written.

isUsingNamedOutputClauses

bool ph::SdlOutputClause::isUsingNamedOutputClauses = false

If the carried name refers to some output clauses.

name

std::string ph::SdlOutputClause::name

Stores a name for the data. May refer to some output clauses. See isUsingNamedOutputClauses.

tag

std::string ph::SdlOutputClause::tag

type

std::string ph::SdlOutputClause::type

value

std::string ph::SdlOutputClause::value

Stores stringified data of a clause. As the output clause generator knows best how its data look like, additional prefixes or suffixes may need to be added to ensure data integrity. For example, if a string contains whitespaces, double quotes should be used (e.g., " many spaces in data "); for an array of quoted elements, curly braces can be used (e.g, {"a", "b", "c"}).

valueType

ESdlClauseValue ph::SdlOutputClause::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 file:

• Source/SDL/SdlOutputClause.h