cbp2make
Makefile generation tool for Code::Blocks IDE
Public Member Functions | Private Attributes | List of all members
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...
 
CPlatformPlatform (const size_t Index) const
 Returns a plafrorm by index. More...
 
CPlatformFind (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::CPlatformSet ( void  )

Creates set of platforms.

◆ ~CPlatformSet()

CPlatformSet::~CPlatformSet ( void  )

Destroys set of platforms.

Member Function Documentation

◆ AddDefault()

void CPlatformSet::AddDefault ( void  )

Registers three default platforms: UNIX, MacOS, Windows.

◆ Clear()

void CPlatformSet::Clear ( void  )

Resets the platform set to the initial state.

◆ Find()

CPlatform * CPlatformSet::Find ( const CPlatform::OS_Type  OS)

Searches a platform by operating system type.

Parameters
OSan operating system type.
Returns
pointer to CPlatform or NULL if the OS parameter is not valid.

◆ GetCount()

size_t CPlatformSet::GetCount ( void  ) const

Returns the number of platforms in the set.

Returns
number of platforms.

◆ Lock()

void CPlatformSet::Lock ( void  )

Locks the platform set to avoid accidental changes.

◆ Platform()

CPlatform * CPlatformSet::Platform ( const size_t  Index) const

Returns a plafrorm by index.

Parameters
Indexa platform index.
Returns
pointer to CPlatform or NULL if the Index parameter is not valid.

◆ Read()

void CPlatformSet::Read ( const TiXmlElement *  ConfigRoot)

Reads a platform set configuration from an XML document.

Parameters
ConfigRootan XML document.

◆ Show()

void CPlatformSet::Show ( void  )

Prints the platform set contents to the standard output.

◆ Unlock()

void CPlatformSet::Unlock ( void  )

Unlocks the platform set.

◆ Write()

void CPlatformSet::Write ( TiXmlElement *  ConfigRoot)

Writes a platform set configuration to an XML document.

Parameters
ConfigRootan XML document.

Member Data Documentation

◆ m_Locked

CPlatformSet::m_Locked
private

A lock for preventing from accidental changes during makefile generation.

◆ m_Platforms

CPlatformSet::m_Platforms
private

A collection of known platfroms.


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