The following diagram illustrates the concept behind the 3D-CAD applications and Energy Analysis Module (EAM). In essence, a 3D-CAD model can be highly complex and have detail that is not relevant to an energy analysis simulation. For this reason the 3D-CAD tool will need to extract a subset of this data for the EAM. The extracted data will be used for energy simulation and the analysis results can be exported to provide feedback to the 3D-CAD model.
A 3D-CAD application as well as the developed client that will interact with the EAM through the Green Building Studio must have the following capabilities and requirements.
- Ability to relate surfaces to spaces.
- Ability to distinguish between surface types, i.e. floor, ceiling, exterior wall, interior wall, etc.
- Ability to clip surfaces based on connection to spaces.
- Ability to store User's username and password on the client computer.
- Ability to save the GBS ProjectID with the 3D-CAD model it is associated with.
- Ability to create, read, edit and write XML documents.
- Ability to open a URL in a browser application.
- Ability to compress a gbXML files using zip compression and encode this file using base 64 encoding.
- Ability to make SOAP calls including through a proxy server.
- Ability to save the gbXML file locally on the client computer.
- Ability to define a unique name for the submitted run.
- Ability to get a valid access token from Oauth server.
This document introduces how developer can setup and consume GBS Web Service APIs with their 3D-CAD application.