DB.Api Namespace Reference

Classes
class	Adjacency
	Class to handle zone surface adjacencies. A zone surface is composed of one or a number of adjacencies where each adjacency is an area of the surface which is either adjacent to another zone or the exterior of the building. More...
class	ApplicationComponents
	Class to handle DB components. Components include various tables of data including constructions, glazing data, profiles, etc. More...
class	ApplicationTemplates
	Class to handle DB templates. Templates include various tables of template data including activity templates, glazing templates, etc. More...
class	Assembly
	Class to handle model assemblies. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. More...
class	AssemblyInstance
	Class to handle model assembly 'instances'. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. More...
class	AssemblyLibrary
	Class to handle model assembly libraries. An assembly library is used to house a number of pre-defined assemblies. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. Each DB model has an associated assembly library. Assemblies may be exported and imported using library functions. More...
class	BoundingBox2d
	Class to handle a 2D bounding box. A 2D bounding box is essentially an object that can be used to define the range of a 2D plane within a DB model. More...
class	BoundingBox3d
	Class to handle a 3D bounding box. A 3D bounding box is essentially an object that can be used to define the range of a 3D region within a DB model. More...
class	Building
	Class to handle a DB model building object. A DB model building object is housed within the model Site object as one of a list of buildings. The building object is primarily composed of a set of building blocks (BuildingBlock objects) but also houses various other model components including component blocks, assembly instances, etc. More...
class	BuildingBlock
	Class to handle a DB model building block object. The building block object is the main geometric component of a DB model and together with other building blocks forms a model building object. A building block may be partitioned into a number of zones and may contain other model components including voids, component blocks, assembly instances, etc. More...
class	CfdGridStatistics
	The CFD grid statistics class applies to standard CFD only and not CFD+. More...
class	CfdResiduals
	Class to handle CFD simulation variable residuals. After each iteration of a CFD simulation, residuals are extracted from the dependent variable equation sets and these residual values may be used as an indicator of the degree to which the calculation has converged to a solution. More...
class	CfdStatus
	Class to handle the status of a CFD simulation. More...
class	Command
	Instantiates list of Command objects using the associated Sketch command strings. More...
class	CommandObject
	Class to handle a command object. A command object provides DB with the status of a Sketch command. More...
class	ComponentBlock
	Class to handle model component blocks. Component blocks may be used to model various components such as occupants, furnishings, shading devices, etc. Component blocks are also used to compose model assemblies. More...
class	ComponentBlockSurface
	Class to handle component block surfaces. More...
class	DataObject
	The DataObject class is used to access the SketchDDataObject which is the class used to house a Sketch model attribute. A model attribute is an object with an assigned name and value that can be associated with any of the Sketch model objects (buildings, building blocks, components, etc.). Attributes are used to associate various data items with model objects (e.g. setpoint temperatures with zones). An inheritance mechanism is built into DB which enables the values of attributes to be inherited from higher levels of decomposition (site->building->building block...) or hard-set at specific levels. More...
class	DecompositionLevelHelp
class	DxfFile
	The DxfFile class provides access to the Sketch DXF file object. A DXF file can be imported into Sketch in the form of line segments allowing model objects to be traced. More...
class	DxfLayer
	The DxfLayer object enables access to the Sketch DXF file object layers allowing layers to be switched off prior to import. The Sketch DXF file object layers correspond to conventional DXF file layers. More...
class	Environment
	Class to handle the Sketch operating environment. The class incorporates methods to set and retrieve the active Sketch command to enable control over the various Sketch operations including drawing model elements, copying, moving, rotating elements, view control, etc. The class also incorporates model navigation methods (changing levels of model decomposition) as well as methods to return API and software versions as well as the various folders used. More...
class	Error
	Class to handle Sketch errors. More...
class	GbXmlConstruction
	Class to handle Sketch gbXML constructions. More...
class	GbXmlFile
	Class to handle Sketch gbXML file data and processes. More...
class	GbXmlFileStats
	Class to handle imported gbXML file information (refer to GbXmlFile FileStatistics method). More...
class	GbXmlLayer
	Class to handle Sketch gbXML layers. More...
class	GbXmlMaterial
	Class to handle Sketch gbXML materials. More...
class	GbXmlWindowType
	Class to handle Sketch gbXML window types. More...
class	HvacComponent
	Class to handle detailed HVAC component. The detailed HVAC component class is used to model the various components available in EnergyPlus. More...
class	HvacIndices
	Class to handle setting and retrieving the various HVAC object current indices. More...
class	HvacLoop
	Class to handle detailed HVAC loops. Loops are a basic element of EnergyPlus HVAC systems. Components are linked together to form various loops within the simulation. Thus, the output node from one component also serves as the inlet node to the next component and so on. There are four basic loop types: air loops, plant lops, condenser loops and VRF loops (refer to the HvacLoopType class). More...
class	HvacNetwork
	Class to handle detailed HVAC network object. The detailed HVAC network object is used to model an EnergyPlus HVAC network and is configured to closely match the structure of an EnergyPlus network in the form of loops, sub-loops and associated components. More...
class	HvacObjectHelp
class	HvacOperationRange
	Class to handle HVAC loop operating scheme ranges. Plant and condenser loop operating schemes are a mechanism for controlling the operation of the loop and for specifying which items of equipment are available under what conditions. More than one operation scheme may be defined for a loop to enable different items of equipment to be switched on/off under different operating conditions. Each operation scheme has the type of operation scheme, its identifying name, and the schedule that defines its availability. Each scheme also contains a number of ranges which allows only specific items from the scheme equipment list to operate within specific load ranges. More...
class	HvacOperationScheme
	Class to handle HVAC loop operating scheme ranges. Plant and condenser loop operating schemes are a mechanism for controlling the operation of the loop and for specifying which items of equipment are available under what conditions. More than one operation scheme may be defined for a loop to enable different items of equipment to be switched on/off under different operating conditions. Each operation scheme has the type of operation scheme, its identifying name, and the schedule that defines its availability. Each scheme also contains a number of ranges which allows only specific items from the scheme equipment list to operate within specific load ranges. More...
class	HvacSubLoop
	Class to handle detailed HVAC sub-loops. Loops are a basic element of EnergyPlus HVAC systems. Components are linked together to form various loops within the simulation. Thus, the output node from one component also serves as the inlet node to the next component and so on. There are four basic loop types: air loops, plant lops, condenser loops and VRF loops (refer to the HvacLoopType class). Each HVAC loop comprises a demand side sub-loop (typically containing zone HVAC equipment such as radiators, air distrubution units, etc.) and a supply sub-loop that incorporates the equipment required to supply the deamnd side (e.g. boilers, chillers, etc.). More...
class	HvacZone
	Class to handle HVAC zones. A zone group is a DB construct that allows zones that contain similar configurations of HVAC components to be grouped together. While the number and types of items of equipment has to be the same for each constituent zone, the equipment can have different operating parameters (e.g. heating output, etc.). The HVAC zone class allows attributes for individual zones within the group to be edited and also allows access to items of zone equipment. More...
class	HvacZoneGroup
	Class to handle HVAC zone groups. A zone group is a DB construct that allows zones that contain similar configurations of HVAC components to be grouped together. While the number and types of items of equipment has to be the same for each constituent zone, the equipment can have different operating parameters (e.g. heating output, etc.). More...
class	ModelIndices
	Class to handle the various current model object indices (indices of objects throughout the model hierarchy above and including the currently selected object). More...
class	ModelObjectHelp
class	OpenGlInfo
	Class to handle information relating to the installed version of OpenGL. More...
class	Opening
	Class to handle surface openings (windows, doors, vents, holes and CFD surface boundary conditions). More...
class	Plane
	Class to handle plane objects. More...
class	Point2d
	Class for 2D points (i.e. points with an x, y coordinate). More...
class	Point3d
	Class to handle 3D points (i.e. points with x, y and z coordinates). More...
class	Polygon
	Class to handle polygon objects. More...
class	Record
	Class to handle DB table records. More...
class	SimpleHvacComponent
	Class to handle simple HVAC components. Simple HVAC components as distinct from detailed HVAC components are not included within a network but are basic components to which attributes can be assigned in order to model HVAC components such as boilers, chillers and AHUs. More...
class	Site
	Class to handle the site object. The site is the highest level object in the Sketch model object hierarchy. The model hierarchy runs from site down to zone surface openings which lie at the bottom of the hierarchy. Sites contain building objects. Building objects can contain component blocks, assembly instances and building blocks. Building blocks can contain component blocks, assembly instances and zones. Zones are comprised of surfaces and surfaces incorporate openings. By default, attribute data can be inherited from the site level down to zone surface opening level but may be overridden at any level in the hierarchy. This class incorporates methods to access objects within the hierarchy and to manipulate attribute data and data stored in tables. More...
class	Surface
	Class to handle zone surfaces. More...
class	Table
	Class to handle data in the form of tables. Tables comprise a specified number of fields (columns) and any number of records (rows). Tables are used by DB for both results and intermediate storage as well as providing a mechanism for DB data table files (.DAT files) which are used to house various databases such as materials and constructions. Tables used to house the .DAT files require the data files to use a specific format whereby the field of each record is delimited using # character, the first record contains field categories and the second record contains the field names. In contrast, tables used for results and intermediate storage don't have the same requirement for the first two records and data is accessed exclusively by index. More...
class	VersionInfo
	Class for API version information. More...
class	Warning
	Class to handle Sketch warnings. If a warning condition is encountered by Sketch, it will issue a warning event. Once a warning event is received by DB, details of the warning(s) can be obtained using the Warning class. More...
class	Zone
	Class to handle building zones. More...
class	ZoneBridgingLengths
	Class used to handle zone thermal bridging lengths. Thermal bridging lengths for all building zones may be calculated using the Building object CreateThermalBridgingSurfaceEdgeList method. After calling this method, the bridging lengths may be retrieved using the Zone object ThermalBridgingLengths method which returns the bridging lengths in the form of a ZoneBridgingLengths object. More...

Enumerations
enum	AdjacencyCondition {   NotAdjacentToGround = 0 , AdjacentToGround = 1 , PartiallyAdjacentToGround = 2 , Adiabatic = 3 ,   AdjacentToSpecifiedCondition = 4 }
	Enumerated type for adjacency condition.
enum	ApplicationMode {   BuildingModeller = 0 , Visualisation = 1 , Cfd = 2 , HvacSystemModeller = 3 ,   DataAnalysis = 4 }
	Ennumerated type for Sketch screens (applications)
enum	BooleanBlockType {   BuildingBlock , ComponentBlock , OutlineBlock , BuildingAndOutlineBlock ,   ComponentAndOutlineBlock }
	Ennumerated type for the type returned by the Environment GetBooleanBlockType method
enum	BuildingBlockType {   PlanExtrusion = 0 , Roof = 1 , SlopingWalls = 2 , Dome = 3 ,   General = 4 }
	Ennumerated type for BuildingBlock object type.
enum	CfdVariableType {   UComponent = 0 , VComponent = 1 , WComponent = 2 , Temperature = 3 ,   Velocity = 4 , Pressure = 5 , H2OMassFraction = 6 , CO2MassFraction = 7 ,   AgeOfAir = 8 , Boundary = 9 , Ppd = 10 , Pmv = 11 ,   MeanRadiantTemperature = 12 , OperativeTemperature = 13 }
	Ennumerated type for CFD dependent variables.
enum	ColouredObject {   Default = 0 , Background = 1 , Highlight = 2 , Inactive = 3 ,   FloorSlab = 4 , BuildingBlock = 5 , InternalPartition = 6 , Zone = 7 ,   ZoneSurface = 8 , XAxis = 9 , YAxis = 10 , ZAxis = 11 ,   LightSensor = 12 , Adiabatic = 13 , AdjacentToGround = 14 , DimensionLine = 15 ,   DimensionText = 16 , Protractor = 17 , NorthMarker = 18 , ConstructionLine = 19 ,   ObjectTranslationGuide = 20 , BlockOpening = 21 , Window = 22 , Door = 23 ,   Hole = 24 , Subsurface = 25 , Vent = 26 , DefaultOpenings = 27 ,   Parallel = 28 , Normal = 29 , Angular = 30 , DynamicSegment = 31 ,   OutlineBlock = 32 , ComponentBlock = 33 , Assembly = 34 , LocalXAxis = 35 ,   LocalYAxis = 36 , ZoneLabel = 37 , Wireframe = 38 , Ghostline = 39 ,   SpecifiedCondition = 40 , SunpathAltitudeKey = 41 , SunpathAzimuthKey = 42 , Sunpath = 43 ,   SunpathText = 44 , SunpathSun = 45 , SunpathSolarRay = 46 , SunpathAzimuth = 47 ,   SunpathAltitude = 48 , OpenManifoldBlock = 49 , OpenManifoldBlockOpening = 50 }
	Ennumerated type for Sketch object colours.
enum	ComponentBlockType {   Normal = 0 , Ground = 1 , Adiabatic = 2 , SpecifiedCondition = 3 ,   SolarCollector = 4 , CfdAceBreathingZone = 5 }
	Ennumerated types for types of component block.
enum	DecompositionLevel {   Site = 0 , Building = 1 , BuildingObject = 2 , BuildingComponentSurface = 3 ,   BuildingComponentSurfaceOpening = 4 , BuildingAssemblyComponent = 5 , BuildingAssemblyComponentSurface = 6 , BuildingAssemblyComponentSurfaceOpening = 7 ,   BuildingBlockObject = 8 , BuildingBlockZoneSurface = 9 , BuildingBlockZoneSurfaceOpening = 10 , BuildingBlockComponentSurface = 11 ,   BuildingBlockComponentSurfaceOpening = 12 , BuildingBlockAssemblyComponent = 13 , BuildingBlockAssemblyComponentSurface = 14 , BuildingBlockAssemblyComponentSurfaceOpening = 15 ,   HvacSystem = 1000 , HvacSystemObject = 1001 , HvacSubLoop = 1002 , HvacSubLoopComponent = 1003 ,   HvacZone = 1004 , HvacZoneComponent = 1005 , HvacSubLoopSubComponent = 1006 , HvacZoneSubComponent = 1007 ,   HvacLoopComponent = 1008 }
	Ennumerated type for model levels of decomposition and detailed HVAC system levels of decomposition.
enum	ErrorCategory { Null , FileName , HvacObjectName , ModelObjectName }
	Enumerated type for the Error class ErrorCategory (see Error class).
enum	HvacComponentType {   Chiller = 0 , Boiler = 1 , WaterCoolingCoil = 2 , HeatingCoil = 3 ,   SupplyFan = 4 , ExtractFan = 5 , SteamHumidifier = 6 , Pump = 7 ,   ZoneGroup = 8 , AirHandlingUnit = 9 , ZoneConvectiveWaterBaseboard = 10 , ZoneChilledCeiling = 11 ,   ZoneHeatedFloor = 12 , ZoneUnit = 13 , ZoneExtract = 14 , ZoneAduLouvre = 15 ,   ZoneAduDualDuctMixingBox = 16 , ZoneAduPiuExtractGrille = 17 , ZoneAduPiuIntakeLouvre = 18 , ZoneFanCoilUnit = 19 ,   ZoneAduDirectAir = 20 , ZoneAduSeriesPiu = 21 , ZoneAduParallelPiu = 22 , ZoneAduFourpipeInduction = 23 ,   ZoneAduSingleDuctCavReheat = 24 , ZoneAduSingleDuctVavReheat = 25 , ZoneAduSingleDuctVavReheatVsFan = 26 , ZoneAduSingleDuctVavNoReheat = 27 ,   ZoneAduDualDuctCav = 28 , ZoneAduDualDuctVav = 29 , Splitter = 30 , Mixer = 31 ,   ZoneSplitter = 32 , ZoneMixer = 33 , SubloopNode = 34 , CoolingTower = 35 ,   ChillerCondenser = 36 , OutdoorAirMixer = 37 , SupplyPlenum = 38 , ReturnPlenum = 39 ,   CooledBeam = 40 , ZoneAduCooledBeam = 41 , DxCoolingCoil = 42 , SetpointManager = 43 ,   DxHeatingCoil = 44 , ZoneTerminalPackagedHeatPump = 45 , ZoneConvectiveElectricBaseboard = 46 , ZoneradiativeConvectiveWaterBaseboard = 47 ,   ZoneradiativeConvectiveElectricBaseboard = 48 , UnitaryHeatPumpAirToAir = 49 , ZoneTerminalPackagedAirConditioner = 50 , ElectricHeatingCoil = 51 ,   UnitaryHeatCool = 52 , ElectricReheatCoil = 53 , WaterHeater = 54 , WaterHeaterElement = 55 ,   DomesticWaterEquipment = 56 , DomesticWaterConnections = 57 , UnitaryCoolingCoil = 58 , EvaporativeCooler = 59 ,   SolarCollector = 60 , TemperingValve = 61 , HeatPumpCooling = 62 , HeatPumpHeating = 63 ,   GroundHeatExchanger = 64 , ZoneExhaustFan = 65 , FluidToFluidHeatExchanger = 66 , FluidToFluidHeatExchangerElement = 67 ,   WatertoAirHeatPumpCoolingCoil = 68 , WatertoAirHeatPumpHeatingCoil = 69 , UnitaryHeatPumpWaterToAir = 70 , ZoneWaterToAirHeatPump = 71 ,   DistrictHeating = 72 , DistrictCooling = 73 , ZoneVariableRefrigerantFlowUnit = 74 , VariableRefrigerantFlowHeatingDxCoil = 75 ,   VariableRefrigerantFlowCoolingDxCoil = 76 , VariableRefrigerantFlowAirConditioner = 77 , WaterHeaterHeatPump = 78 , AirToWaterHeatPumpWaterHeatingCoil = 79 ,   ZoneWaterHeaterHeatPump = 80 , FluidCooler = 81 , ChillerHrHeatExchanger = 82 , ZoneAduSingleDuctOutdoorAirVav = 83 ,   ZoneAduDualDuctOutdoorAirVav = 84 , AbsorptionChillerGenerator = 85 , UnitaryHeatingCoil = 86 , ZoneRadiantSurface = 87 ,   ZoneRadiantSurfaceHeatingElement = 88 , ZoneRadiantSurfaceCoolingElement = 89 , ChilledWaterStorageHeatExchanger = 90 , ChilledWaterStorage = 91 ,   IceThermalsSorage = 92 , Generator = 93 }
	Enumerated type for HVAC components.
enum	HvacFanType { ConstantVolume = 0 , VariableVolume = 1 , OnOff = 2 }
	Enumerated type for air handling unit fans.
enum	HvacHeatingCoilType { Water = 0 , Electric = 1 , Fuel = 2 }
	Enumerated type for heating coils.
enum	HvacLoopType {   Air = 0 , Plant = 1 , Condenser = 2 , VRF = 3 ,   Any = 4 }
	Enumerated type for HVAC loop type.
enum	HvacObjectType {   System = 0 , Loop = 1 , ZoneGroup = 2 , SubLoop = 3 ,   SubLoopComponent = 4 , SubLoopSubComponent = 5 , Zone = 6 , ZoneComponent = 7 ,   ZoneSubSomponent = 8 , LoopComponent = 9 }
	Enumerated type for HVAC object types.
enum	HvacPlantLoopType {   HotWater = 0 , ChilledWater = 1 , DomesticHotWater = 2 , SolarHeating = 3 ,   HeatRecovery = 4 , AuxiliaryHotWater = 5 }
	Enumerated type for HVAC plant loop type.
enum	InnerSurfaceMode { Coincident = 0 , Deflation = 1 , Approximate = 2 , OpenManifold = 3 }
	Enumerated type for zone inner surface mode.
enum	InternalPartitionType { Solid = 0 , Virtual = 1 }
	Enumerated type for internal partition type.
enum	ModelObjectType {   Site , Building , BuildingBlock , ComponentBlock ,   AssemblyInstance , Plane , Zone , Surface ,   Opening }
	Enumerated type for currently selected model object.
enum	OpeningType {   Window , Door , Vent , Surface ,   Hole , Supply , Extract , FixedTemperature ,   Heat , TwoWaySupply , FourWaySupply , CalcVentSupply ,   CalcVentExtract , Pressure , CfdSurface , FixedTemperatureSurface ,   HeatSurface , Adiabatic }
	Enumerated type for opening types.
enum	PerimeterShape { Rectangular = 0 , General = 1 , Circular = 2 }
	Enumerated type for perimeter shape used for drawing various objects such as block perimeters.
enum	PolygonType {   InternalWindowFrame = 1 , ExternalWindowFrame = 2 , InternalWindowPane = 3 , ExternalWindowPane = 4 ,   InternalDoorPanel = 5 , ExternalDoorPanel = 6 , InternalVentPanel = 7 , ExternalVentPanel = 8 ,   InternalSubsurface = 9 , ExternalSubsurface = 10 , ExternalZoneSurfaceOutline = 11 , ExternalZoneSurface = 12 ,   InternalZoneSurface = 13 , InternalZoneOpeningOutline = 14 , BlockInterfaceSurface = 15 , InternalRevealSrface = 16 ,   ExternalRevealSurface = 17 , LouvreComponent = 18 , EPLouvreFace = 19 , ZoneInternalPartitionOutline = 20 }
	Enumerated type for polygons associated with particular model objects.
enum	ProjectMode { Site = 0 , BuildingBookmark = 1 }
	Enumerated type for project mode used by the Environment class ImportProject method.
enum	SurfaceType {   Floor = 0 , FlatRoof = 1 , PitchedRoof = 2 , Wall = 3 ,   Hole = 4 , GroundAdjacentSurface = 5 , AdiabaticSurface = 6 , SpecifiedConditionAdjacentSurface = 7 ,   InternalPartition = 8 , ComponentBlockAdjacentSurface = 9 }
	Enumerated type for surface types.
enum	ViewRotationType {   Plan = 0 , Left = 1 , Right = 2 , Back = 3 ,   Front = 4 , Axonometric = 5 }
	Enumerated type for the Sketch view rotation types.
enum	ViewType {   BuildingModeller = 0 , Visualisation = 1 , Cfd = 2 , HvacSystemModeller = 3 ,   DataAnalysis = 4 }
	Enumerated type for the Sketch application type.