This class can be used to query the boundaries of Zones. Before use an Update must be called on it. More...

#include <ZoneBoundaryQuery.hpp>

Inheritance diagram for ACAPI::v1::ZoneBoundaryQuery:

Public Member Functions
Result< std::vector< ZoneBoundary > >	GetZoneBoundaries (API_Guid zoneId) const

template<typename ModifierFunc >
Result< void >	Modify (ModifierFunc &&modifierFunc)
	Executes the given modifier scope in a NotUndoable command.

Result< void >	Update (GS::ProcessControl &)
	Updates the boundaries of the Zones in the current view. Works only on Floor Plan window and 3D Model window.

Public Member Functions inherited from ACAPI::v1::Object
	Object (std::shared_ptr< Impl::ObjectImpl > impl)
	Constructs a new object.

const API_Token &	GetToken () const
	Get the token for this object.

Additional Inherited Members
Protected Member Functions inherited from ACAPI::v1::Object
	~Object ()
	Default destructor.

Protected Attributes inherited from ACAPI::v1::Object
std::shared_ptr< Impl::ObjectImpl >	mImpl
	Impl object given by constructor.

Detailed Description

This class can be used to query the boundaries of Zones. Before use an Update must be called on it.

Member Function Documentation

Result< std::vector< ZoneBoundary > > ACAPI::v1::ZoneBoundaryQuery::GetZoneBoundaries ( API_Guid zoneId ) const

Parameters

zoneId The unique identifier of the Zone.

Returns: Returns the boundaries of the given Zone if it exists, otherwise Error.

template<typename ModifierFunc >

Result< void > ACAPI::v1::ZoneBoundaryQuery::Modify ( ModifierFunc && modifierFunc )

Executes the given modifier scope in a NotUndoable command.

Parameters

modifierFunc The modifier scope (lambda, std::function or function pointer) the caller wants to execute.

Returns: Returns an error if the process of modification fails for some reason, otherwise nothing.

Result< void > ACAPI::v1::ZoneBoundaryQuery::Update ( GS::ProcessControl & )

Updates the boundaries of the Zones in the current view. Works only on Floor Plan window and 3D Model window.

Returns: Returns an error if the current window is not Floor Plan or 3D Model.

ZoneBoundaryQuery CreateZoneBoundaryQuery ( )

friend