#include <BCLComponent.hpp>

Public Member Functions
Constructors
	BCLComponent ()
	Default constructor for a new component. More...

	BCLComponent (const openstudio::path &dir)
	Constructor for downloaded components, path is to directory containing "component.xml" file. More...

Destructor
Constructor for downloaded components, path is to directory containing "component.xml" file
virtual	~BCLComponent ()=default
	Virtual destructor. More...

Getters
openstudio::path	directory () const

std::string	uid () const

std::string	versionId () const

std::string	name () const

std::string	description () const

std::vector< std::string >	files () const

std::vector< std::string >	files (const std::string &filetype) const

std::vector< std::string >	filetypes () const

std::vector< Attribute >	attributes () const

Setters
void	setName (const std::string &name)

Operators
bool	operator== (const BCLComponent &other) const
	Equality test - Compares the uids and versionIds of two separate components. More...

bool	operator!= (const BCLComponent &other) const
	Negation of ==. More...

bool	operator< (const BCLComponent &other) const
	Less than. More...

Related Functions
(Note that these are not member functions.)
using	BCLComponentVector = std::vector< BCLComponent >

using	OptionalBCLComponent = boost::optional< BCLComponent >

Constructor & Destructor Documentation

openstudio::BCLComponent::BCLComponent ( )

Default constructor for a new component.

openstudio::BCLComponent::BCLComponent ( const openstudio::path & dir )

Constructor for downloaded components, path is to directory containing "component.xml" file.

virtual openstudio::BCLComponent::~BCLComponent ( )

virtualdefault

Virtual destructor.

Member Function Documentation

std::vector<Attribute> openstudio::BCLComponent::attributes ( ) const

std::string openstudio::BCLComponent::description ( ) const

openstudio::path openstudio::BCLComponent::directory ( ) const

std::vector<std::string> openstudio::BCLComponent::files ( ) const

std::vector<std::string> openstudio::BCLComponent::files ( const std::string & filetype ) const

std::vector<std::string> openstudio::BCLComponent::filetypes ( ) const

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

bool openstudio::BCLComponent::operator!= ( const BCLComponent & other ) const

Negation of ==.

bool openstudio::BCLComponent::operator< ( const BCLComponent & other ) const

Less than.

bool openstudio::BCLComponent::operator== ( const BCLComponent & other ) const

Equality test - Compares the uids and versionIds of two separate components.

void openstudio::BCLComponent::setName ( const std::string & name )

std::string openstudio::BCLComponent::uid ( ) const

std::string openstudio::BCLComponent::versionId ( ) const