WorkspaceExtensibleGroup Class Reference

#include "WorkspaceExtensibleGroup.hpp"

Inheritance diagram for openstudio::WorkspaceExtensibleGroup:

Public Member Functions
virtual	~WorkspaceExtensibleGroup ()
boost::optional< WorkspaceObject >	getTarget (unsigned fieldIndex) const
std::vector< WorkspaceObject >	getTargets () const
std::vector< unsigned >	getSourceFieldIndices (const Handle &targetHandle) const
bool	setPointer (unsigned fieldIndex, const Handle &targetHandle)
bool	isSource () const
bool	canBeSource () const

Protected Types
typedef detail::WorkspaceObject_Impl	ImplType

Protected Member Functions
	WorkspaceExtensibleGroup (std::shared_ptr< detail::WorkspaceObject_Impl > impl, unsigned index)

Detailed Description

WorkspaceExtensibleGroup wraps a set of extensible fields in a WorkspaceObject.

Member Typedef Documentation

typedef detail::WorkspaceObject_Impl openstudio::WorkspaceExtensibleGroup::ImplType

protected

Constructor & Destructor Documentation

virtual openstudio::WorkspaceExtensibleGroup::~WorkspaceExtensibleGroup ( )

inlinevirtual

openstudio::WorkspaceExtensibleGroup::WorkspaceExtensibleGroup ( std::shared_ptr< detail::WorkspaceObject_Impl >  impl, unsigned  index  )

protected

Member Function Documentation

bool openstudio::WorkspaceExtensibleGroup::canBeSource

(

)

const

Returns true if this object can point to another object.

To qualify, there must be at least one object-list field.

std::vector<unsigned> openstudio::WorkspaceExtensibleGroup::getSourceFieldIndices

(

const Handle &

targetHandle

)

const

Returns the fieldIndex of the field in this extensible group that points to targetHandle, if possible.

boost::optional<WorkspaceObject> openstudio::WorkspaceExtensibleGroup::getTarget

(

unsigned

fieldIndex

)

const

Returns the object pointed to by field index, if it exists.

std::vector<WorkspaceObject> openstudio::WorkspaceExtensibleGroup::getTargets

(

)

const

Returns all objects pointed to by this object.

bool openstudio::WorkspaceExtensibleGroup::isSource

(

)

const

Returns true if this ExtensibleGroup points to another object.

To qualify, there must be at least one pointer field holding a non-null pointer.

bool openstudio::WorkspaceExtensibleGroup::setPointer	(	unsigned	fieldIndex,
		const Handle &	targetHandle
	)

Sets the pointer at fieldIndex to point to target, if possible.

The field must be of object-list type, and target must be valid (in the containing Workspace, and if the strictness is greater than enums::None, of a proper type).