CPlatformSet Class Reference

Manages a set of platforms. More...

#include <platforms.h>

Public Member Functions
void	Lock (void)
	Locks the platform set to avoid accidental changes. More...
void	Unlock (void)
	Unlocks the platform set. More...
void	Clear (void)
	Resets the platform set to the initial state. More...
size_t	GetCount (void) const
	Returns the number of platforms in the set. More...
CPlatform *	Platform (const size_t Index) const
	Returns a plafrorm by index. More...
CPlatform *	Find (const CPlatform::OS_Type OS)
	Searches a platform by operating system type. More...
void	AddDefault (void)
	Registers three default platforms: UNIX, MacOS, Windows. More...
void	Read (const TiXmlElement *ConfigRoot)
	Reads a platform set configuration from an XML document. More...
void	Write (TiXmlElement *ConfigRoot)
	Writes a platform set configuration to an XML document. More...
void	Show (void)
	Prints the platform set contents to the standard output. More...
	CPlatformSet (void)
	Creates set of platforms. More...
	~CPlatformSet (void)
	Destroys set of platforms. More...

Private Attributes
std::vector< CPlatform * >	m_Platforms
	A collection of known platfroms. More...
bool	m_Locked
	A lock for preventing from accidental changes during makefile generation. More...

Detailed Description

Manages a set of platforms.

Constructor & Destructor Documentation

CPlatformSet::CPlatformSet

(

void

)

Creates set of platforms.

CPlatformSet::~CPlatformSet

(

void

)

Destroys set of platforms.

Member Function Documentation

void CPlatformSet::AddDefault

(

void

)

Registers three default platforms: UNIX, MacOS, Windows.

void CPlatformSet::Clear

(

void

)

Resets the platform set to the initial state.

CPlatform * CPlatformSet::Find

(

const CPlatform::OS_Type

OS)

Searches a platform by operating system type.

Parameters

OS	an operating system type.

Returns

pointer to CPlatform or NULL if the OS parameter is not valid.

size_t CPlatformSet::GetCount

(

void

)

const

Returns the number of platforms in the set.

Returns

number of platforms.

void CPlatformSet::Lock

(

void

)

Locks the platform set to avoid accidental changes.

CPlatform * CPlatformSet::Platform

(

const size_t

Index)

const

Returns a plafrorm by index.

Parameters

Index

a platform index.

Returns

pointer to CPlatform or NULL if the Index parameter is not valid.

void CPlatformSet::Read

(

const TiXmlElement *

ConfigRoot)

Reads a platform set configuration from an XML document.

Parameters

ConfigRoot

an XML document.

void CPlatformSet::Show

(

void

)

Prints the platform set contents to the standard output.

void CPlatformSet::Unlock

(

void

)

Unlocks the platform set.

void CPlatformSet::Write

(

TiXmlElement *

ConfigRoot)

Writes a platform set configuration to an XML document.

Parameters

ConfigRoot

an XML document.

Member Data Documentation

CPlatformSet::m_Locked

private

A lock for preventing from accidental changes during makefile generation.

CPlatformSet::m_Platforms

private

A collection of known platfroms.

---

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

• src/platforms.h
• src/doc/platforms.dox
• src/platforms.cpp