openstudio::AttributeDescription Struct Reference

#include <Attribute.hpp>

Public Member Functions
	AttributeDescription (const std::string &t_name, const std::string &t_displayName, const std::string &t_description, const AttributeValueType &t_validValueType, bool t_required)
	AttributeDescription (const std::string &t_name, const std::string &t_displayName, const std::string &t_description, const AttributeValueType &t_validValueType, bool t_required, OSAttributeVariant t_defaultValue)
	AttributeDescription (const std::string &t_name, const std::string &t_displayName, const std::string &t_description, const std::vector< AttributeValueType > &t_validValueTypes, bool t_required)
	AttributeDescription (const std::string &t_name, const std::string &t_displayName, const std::string &t_description, const std::vector< AttributeValueType > &t_validValueTypes, bool t_required, OSAttributeVariant t_defaultValue)

Public Attributes
OSAttributeVariant	defaultValue
std::string	description
std::string	displayName
std::string	name
bool	required
std::vector< AttributeValueType >	validValueTypes

Related Functions
(Note that these are not member functions.)
using	AttributeDescriptionVector = std::vector< AttributeDescription >
using	OptionalAttributeDescription = boost::optional< AttributeDescription >

Detailed Description

AttributeDescription describes what an acceptable Attribute is in a given context.

At this time, it is primarily used in openstudio::analysis::GenericUncertaintyDescription. Note that AttributeDescription was designed to provide the information needed by a UI developer to properly prompt a user for the data needed to create a new Attribute.

Constructor & Destructor Documentation

openstudio::AttributeDescription::AttributeDescription	(	const std::string &	t_name,
		const std::string &	t_displayName,
		const std::string &	t_description,
		const AttributeValueType &	t_validValueType,
		bool	t_required
	)

openstudio::AttributeDescription::AttributeDescription	(	const std::string &	t_name,
		const std::string &	t_displayName,
		const std::string &	t_description,
		const AttributeValueType &	t_validValueType,
		bool	t_required,
		OSAttributeVariant	t_defaultValue
	)

openstudio::AttributeDescription::AttributeDescription	(	const std::string &	t_name,
		const std::string &	t_displayName,
		const std::string &	t_description,
		const std::vector< AttributeValueType > &	t_validValueTypes,
		bool	t_required
	)

openstudio::AttributeDescription::AttributeDescription	(	const std::string &	t_name,
		const std::string &	t_displayName,
		const std::string &	t_description,
		const std::vector< AttributeValueType > &	t_validValueTypes,
		bool	t_required,
		OSAttributeVariant	t_defaultValue
	)

Friends And Related Function Documentation

using AttributeDescriptionVector = std::vector<AttributeDescription>

related

using OptionalAttributeDescription = boost::optional<AttributeDescription>

related

Member Data Documentation

OSAttributeVariant openstudio::AttributeDescription::defaultValue

std::string openstudio::AttributeDescription::description

std::string openstudio::AttributeDescription::displayName

std::string openstudio::AttributeDescription::name

bool openstudio::AttributeDescription::required

std::vector<AttributeValueType> openstudio::AttributeDescription::validValueTypes