Dragonfly Primer
Ladybug Tools for Grasshopper Documentation
  • Dragonfly Primer
  • Components
    • 0 :: Create
      • Deconstruct All Object
      • Deconstruct Model
      • Deconstruct Object
      • Model
      • Building from Detailed Rooms
      • Building from Footprint
      • Building from Solid
      • Building from Stories
      • Process Alleys
      • Separate Top Bottom
      • Rejoin to Building
      • Story
      • Room2D
      • Solve Adjacency
      • Apply Facade Parameters
      • Detailed Windows
      • Repeating Window Ratio Parameters
      • Repeating Window Width Height Parameters
      • Simple Window Ratio Parameters
      • Single Window Parameters
      • Extruded Border Parameters
      • Gridded Skylight Parameters
      • Louver Parameters
      • Overhang Parameters
      • Apply Roof
      • ContextShade
      • Align
      • BC by Orientation
      • Deconstruct Roof
      • Intersect Room2Ds
      • Set Ground Top
    • 1 :: Visualize
      • Visualize All
      • Visualize Floors
      • Visualize Quick
      • Visualize Wireframe
      • Geometry Properties
      • Room2D Attributes
      • Color Room2D Attributes
      • Room2Ds by Attribute
      • Color Network Attributes
      • Network Attributes
      • Color Network Results
    • 2 :: Serialize
      • Object to String
      • String to Object
      • Dump Objects
      • Load Objects
      • Model To Honeybee
      • Model To geoJSON
      • Model From Honeybee
      • Model From geoJSON
      • Validate Model
    • 3 :: Energy
      • Run OpenDSS
      • Run REopt
      • Run RNM
      • Run URBANopt
      • Diversify Building Programs
      • Load Mapper Measure
      • Process Load
      • Reassign Energy Properties
      • All-Air HVAC
      • DOAS HVAC
      • Detailed HVAC
      • HeatCool HVAC
      • IdealAir
      • SHW System
      • Electrical Connector
      • Electrical Network
      • Ground Photovoltaics
      • Road Network
      • Substation
      • Transformer
      • Read OpenDSS Result
      • Search OpenDSS
      • Deconstruct OpenDSS
      • Fourth Generation Thermal Loop
      • GHE Thermal Loop
      • REopt Financial Parameters
      • Run Modelica DES
      • Window Opening
    • 4 :: AlternativeWeather
      • Run Urban Weather Generator
      • UWG Simulation Parameter
      • Assign Building UWG Properties
      • Assign Model UWG Properties
      • Terrain
      • Traffic Parameters
      • Construct Design Day
      • Create EPW
      • Write DDY
      • Write EPW
      • Horizontal Infrared
      • Import NOAA File
      • Boundary Layer Parameters
      • Luminous Efficacy
      • Reference EPW Parameters
      • Vegetation Parameters
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 2 :: Serialize

Dump Objects

PreviousString to ObjectNextLoad Objects

Last updated 3 years ago

-

Dump any dragonfly object to a JSON file. You can use "DF Load Objects" component to load the objects from the file back into Grasshopper.

This includes any Model, Building, Story, Room2D, WindowParameter, or ShadingParameter.

It also includes any energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

  • df_objs [Required]

    A list of Dragonfly objects to be written to a file.

  • name

    A name for the file to which the dragonfly objects will be written. (Default: 'unnamed').

  • folder

    An optional directory into which the dragonfly objects will be written. The default is set to the default simulation folder.

  • indent

    An optional positive integer to set the indentation used in the resulting JSON file.

  • abridged

    Set to "True" to serialize the object in its abridged form. Abridged objects cannot be reserialized back to dragonfly objects on their own but they are used throughout dragonfly to minimize file size and unnecessary duplication.

  • dump [Required]

    Set to "True" to save the dragonfly objects to file.

Outputs

  • report

    Errors, warnings, etc.

  • df_file

    The location of the file where the dragonfly JSON is saved.

[source code]