SilverLining::CloudLayerFactory Class Reference

A class factory for CloudLayer objects. More...

#include <CloudLayerFactory.h>

Inherits SilverLining::MemObject.

Collaboration diagram for SilverLining::CloudLayerFactory:
Collaboration graph
[legend]

List of all members.

Static Public Member Functions

static CloudLayer *SILVERLINING_API Create (CloudTypes layerType)
 Instantiate a CloudLayer for a given cloud type.
static bool SILVERLINING_API Serialize (CloudLayer *layer, std::ostream &stream)
 Flattens a cloud layer to a stream buffer.
static CloudLayer *SILVERLINING_API Unserialize (const Atmosphere &atm, std::istream &stream)
 Restores a cloud layer from a stream buffer written with Serialize().

Detailed Description

A class factory for CloudLayer objects.

Call CloudLayerFactory::Create to instantiate a CloudLayer object, which may then be configured, seeded, and submitted to the AtmosphericConditions. CloudLayer is a virtual base class, so this is the only mechanism for creating specific cloud layer types.


Member Function Documentation

static CloudLayer* SILVERLINING_API SilverLining::CloudLayerFactory::Create ( CloudTypes  layerType  )  [static]

Instantiate a CloudLayer for a given cloud type.

Currently supported CloudTypes include:

Parameters:
layerType The type of cloud deck to create, must be of the CloudTypes enumeration.
Returns:
A pointer to a new CloudLayer for the specified type.
static bool SILVERLINING_API SilverLining::CloudLayerFactory::Serialize ( CloudLayer layer,
std::ostream &  stream 
) [static]

Flattens a cloud layer to a stream buffer.


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

Generated on 22 Mar 2012 for SilverLining by  doxygen 1.6.1