openstudio::BCLComponent Class Reference

#include <BCLComponent.hpp>

Public Member Functions
Constructors
	BCLComponent ()
	Default constructor for a new component.
	BCLComponent (const openstudio::path &dir)
	Constructor for downloaded components, path is to directory containing "component.xml" file.
Destructor
Constructor for downloaded components, path is to directory containing "component.xml" file
virtual	~BCLComponent ()=default
	Virtual destructor.
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)

Related Symbols
(Note that these are not member symbols.)
using	BCLComponentVector = std::vector<BCLComponent>
using	OptionalBCLComponent = boost::optional<BCLComponent>

Operators
bool	operator== (const BCLComponent &other) const
	Equality test - Compares the uids and versionIds of two separate components.
bool	operator!= (const BCLComponent &other) const
	Negation of ==.
bool	operator< (const BCLComponent &other) const
	Less than.

Constructor & Destructor Documentation

BCLComponent() [1/2]

openstudio::BCLComponent::BCLComponent

(

)

Default constructor for a new component.

BCLComponent() [2/2]

openstudio::BCLComponent::BCLComponent

(

const openstudio::path &

dir

)

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

~BCLComponent()

virtual openstudio::BCLComponent::~BCLComponent ( )

virtualdefault

Virtual destructor.

Member Function Documentation

attributes()

std::vector< Attribute > openstudio::BCLComponent::attributes

(

)

const

description()

std::string openstudio::BCLComponent::description

(

)

const

directory()

openstudio::path openstudio::BCLComponent::directory

(

)

const

files() [1/2]

std::vector< std::string > openstudio::BCLComponent::files

(

)

const

files() [2/2]

std::vector< std::string > openstudio::BCLComponent::files

(

const std::string &

filetype

)

const

filetypes()

std::vector< std::string > openstudio::BCLComponent::filetypes

(

)

const

name()

std::string openstudio::BCLComponent::name

(

)

const

operator!=()

bool openstudio::BCLComponent::operator!=

(

const BCLComponent &

other

)

const

Negation of ==.

operator<()

bool openstudio::BCLComponent::operator<

(

const BCLComponent &

other

)

const

Less than.

operator==()

bool openstudio::BCLComponent::operator==

(

const BCLComponent &

other

)

const

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

setName()

void openstudio::BCLComponent::setName

(

const std::string &

name

)

uid()

std::string openstudio::BCLComponent::uid

(

)

const

versionId()

std::string openstudio::BCLComponent::versionId

(

)

const

Friends And Related Symbol Documentation

BCLComponentVector

using BCLComponentVector = std::vector<BCLComponent>

related

OptionalBCLComponent

using OptionalBCLComponent = boost::optional<BCLComponent>

related