ph::SdlIOContext Class Reference

Data that SDL input/output process can rely on. More...

#include <SdlIOContext.h>

Inheritance diagram for ph::SdlIOContext:

Public Member Functions
std::string	genPrettySrcInfo () const
const Path &	getWorkingDirectory () const
	Get working directory of the current I/O session. Do not treat this as the classical definition of working directory (for a process). A SDL working directory may be different for each I/O session, and different to the working directory of the current process.
const SdlClass *	getSrcClass () const
	The SDL class that is involved in the I/O process.
const SdlStruct *	getSrcStruct () const
void	setSrcClass (const SdlClass *srcClass)
void	setSrcStruct (const SdlStruct *srcStruct)

Protected Member Functions
	SdlIOContext ()
	SdlIOContext (const Path *workingDirectory, const SdlClass *srcClass=nullptr, const SdlStruct *srcStruct=nullptr)
	SdlIOContext (const SdlIOContext &other)=default
	SdlIOContext (SdlIOContext &&other)=default
SdlIOContext &	operator= (const SdlIOContext &rhs)=default
SdlIOContext &	operator= (SdlIOContext &&rhs)=default

Detailed Description

Data that SDL input/output process can rely on.

Constructor & Destructor Documentation

SdlIOContext() [1/4]

ph::SdlIOContext::SdlIOContext ( )

inlineprotected

SdlIOContext() [2/4]

ph::SdlIOContext::SdlIOContext ( const Path * workingDirectory, const SdlClass * srcClass = nullptr, const SdlStruct * srcStruct = nullptr )

inlineexplicitprotected

Parameters

workingDirectory

Working directory of the current SDL IO process. Note that SDL working directory can be different to the program's working directory. It is specific to the related SDL command.

SdlIOContext() [3/4]

ph::SdlIOContext::SdlIOContext ( const SdlIOContext & other )

protecteddefault

SdlIOContext() [4/4]

ph::SdlIOContext::SdlIOContext ( SdlIOContext && other )

protecteddefault

Member Function Documentation

genPrettySrcInfo()

std::string ph::SdlIOContext::genPrettySrcInfo

(

)

const

getSrcClass()

const SdlClass * ph::SdlIOContext::getSrcClass ( ) const

inline

The SDL class that is involved in the I/O process.

Returns

The source SDL class. May be empty if no class is involved or such information cannot be obtained.

getSrcStruct()

const SdlStruct * ph::SdlIOContext::getSrcStruct ( ) const

inline

getWorkingDirectory()

const Path & ph::SdlIOContext::getWorkingDirectory ( ) const

inline

Get working directory of the current I/O session. Do not treat this as the classical definition of working directory (for a process). A SDL working directory may be different for each I/O session, and different to the working directory of the current process.

operator=() [1/2]

SdlIOContext & ph::SdlIOContext::operator= ( const SdlIOContext & rhs )

protecteddefault

operator=() [2/2]

SdlIOContext & ph::SdlIOContext::operator= ( SdlIOContext && rhs )

protecteddefault

setSrcClass()

void ph::SdlIOContext::setSrcClass ( const SdlClass * srcClass )

inline

setSrcStruct()

void ph::SdlIOContext::setSrcStruct ( const SdlStruct * srcStruct )

inline

---

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

• Source/SDL/Introspect/SdlIOContext.h
• Source/SDL/Introspect/SdlIOContext.cpp