OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
List of all members
openstudio::OnDemandGeneratorValueRestriction Class Reference

#include <OnDemandGenerator.hpp>

Public Member Functions

Constructor
 OnDemandGeneratorValueRestriction (const QDomElement &valueElement)
 Constructs an OnDemandGeneratorValueRestriction from its xml description. More...
 
Destructors
virtual ~OnDemandGeneratorValueRestriction ()
 virtual destructor More...
 
Class members
std::string name () const
 Returns the name of this restriction, if this restriction represents an allowable value for a string enumeration then name returns the allowable value. More...
 
std::vector
< OnDemandGeneratorArgument
nestedArguments () const
 Returns any additional arguments which are accepted if a value covered by this restriction is selected. More...
 

Detailed Description

This class represents any restrictions on argument to an on demand generator script.

Currently, the only value restriction allowed is that of a string enumeration. In this case each OnDemandGeneratorValueRestriction represents an allowable value for the enumeration. Nested arguments represent additional arguments which are present only if this value

Constructor & Destructor Documentation

openstudio::OnDemandGeneratorValueRestriction::OnDemandGeneratorValueRestriction ( const QDomElement &  valueElement)

Constructs an OnDemandGeneratorValueRestriction from its xml description.

virtual openstudio::OnDemandGeneratorValueRestriction::~OnDemandGeneratorValueRestriction ( )
virtual

virtual destructor

Member Function Documentation

std::string openstudio::OnDemandGeneratorValueRestriction::name ( ) const

Returns the name of this restriction, if this restriction represents an allowable value for a string enumeration then name returns the allowable value.

std::vector<OnDemandGeneratorArgument> openstudio::OnDemandGeneratorValueRestriction::nestedArguments ( ) const

Returns any additional arguments which are accepted if a value covered by this restriction is selected.