ph::SdlDataPacketInterface Class Reference

Parsing & generating a group of SDL clauses. More...

#include <SdlDataPacketInterface.h>

Inheritance diagram for ph::SdlDataPacketInterface:

Public Member Functions
	SdlDataPacketInterface ()
virtual	~SdlDataPacketInterface ()
virtual void	parse (std::string_view packetCommand, const SdlInputContext &ctx, std::string_view targetName, ISdlResource *targetInstance, SdlInputClauses &out_clauses) const =0
	Turn a packet command into out_clauses.
virtual void	generate (const SdlOutputClauses &clauses, const SdlOutputContext &ctx, std::string_view targetName, const ISdlResource *targetInstance, std::string &out_packetCommand) const =0
	Turn all data in the clauses into a packet command.

Detailed Description

Parsing & generating a group of SDL clauses.

Constructor & Destructor Documentation

SdlDataPacketInterface()

ph::SdlDataPacketInterface::SdlDataPacketInterface

(

)

~SdlDataPacketInterface()

ph::SdlDataPacketInterface::~SdlDataPacketInterface ( )

virtualdefault

Member Function Documentation

generate()

virtual void ph::SdlDataPacketInterface::generate ( const SdlOutputClauses & clauses, const SdlOutputContext & ctx, std::string_view targetName, const ISdlResource * targetInstance, std::string & out_packetCommand ) const

pure virtual

Turn all data in the clauses into a packet command.

Parameters

	targetClass	The class current packet is being generated for. Null if unavailable.
	targetName	The target's name current packet is being generated for. Empty if unavailable.
	targetInstance	Pointer to the instance current packet is being generated for. Null if unavailable.
[out]	out_packetCommand	Generated packet command. Results are appended.

Implemented in ph::SdlInlinePacketInterface.

parse()

virtual void ph::SdlDataPacketInterface::parse ( std::string_view packetCommand, const SdlInputContext & ctx, std::string_view targetName, ISdlResource * targetInstance, SdlInputClauses & out_clauses ) const

pure virtual

Turn a packet command into out_clauses.

Parameters

	targetClass	The class current packet is being parsed for. Null if unavailable.
	targetName	The target's name current packet is being parsed for. Empty if unavailable.
	targetInstance	Pointer to the instance current packet is being parsed for. Null if unavailable.
[out]	out_clauses	Parsed clauses. Results are appended and will be used for initializing the target instance.

Implemented in ph::SdlInlinePacketInterface.

---

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

• Source/SDL/SdlDataPacketInterface.h
• Source/SDL/SdlDataPacketInterface.cpp