Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

The "Export" object is an object that contains the values for which an object is to be exported. Any parameter put into the "Export" object is exported just like the Role="Input" parameters. These exported values function to be used in inter-object communication.


When an object is called in the App, it is retrieved from the Library and processed according to its type. Then Role="Input" deletes all external parameters from its memory. The "Export" object is used to move the intermediate parameters that are not to be deleted from the Library to the App, and thus the parameters in the "Export" object are moved to the Source Code in the App.


When enter the app and start a new project, the objects in the library are called first. As a procedure, the library is accessed, the code there is run, the input values are taken and transferred to the user in the App. Other intermediate parameters related to that object in the library are not kept in its memory and are deleted.

What if other intermediate parameters, which are not required for this user and which the App does not keep in its memory, are required for another object? That's when the "Export" object comes into play and when the code of an object written in the library runs through the App, it provides the input parameters to be taken, and the parameters in the "Export" to be transferred to the App in the same way, and thus the intermediate parameters go into the source code.
When the code of a Library object is executed in the App, it returns results based on the object's type. There are four types of results available in the App.

  • The first type of result that can be obtained is a 3D model, which is created using objects such as "Volume", "Line", and "Surface" (found in the Core Objects category).

  • The second type of result is obtaining CADD drawings, which is achieved using CADD objects or the "CADDFrom3D" object (found in the Core Objects category).

  • The third type of result is a specification check, which is performed using the "DesignCode" object.

  • The fourth type of result is the ability to perform finite element analysis, which is achieved using analysis and finite element objects.

  • An example of how the "Export" object connects the Library and App is as follows: In a Library object, certain intermediate parameters are calculated and stored in the "Export" object. These values are then passed to an App, where they are used in the source code to perform specific tasks, such as creating a 3D model or checking design specifications.

When two separate objects are created in the Library and used in an App, they function as follows:

  • The App requests the objects from the Library and retrieves them.

  • The objects are then processed according to their respective types, such as 3D modeling, CADD drawings, specification checks, or finite element analysis.

  • The input parameters for each object are deleted from memory, but any values in the "Export" object are transferred to the App's source code.

  • The objects then perform their designated functions in the App, using the transferred "Export" values and any other necessary parameters.

  • The objects return their respective results, such as a 3D model, CADD drawings, specification check results, or analysis results, to the App for further use.

It's important to note that the objects are independent of one another, meaning that the output of one does not affect the functioning of the other.

The operating of two separate Objects created in the Library in the OpenBrIM App:

Example: 

   ...
   ...
    <O T="Export">
        <O N="Parameters" T="Group">
            <P N="Topelevation" V="depth" />
            <P N="ElevationDif" V="Topelevation+25" />
        </O>
        <O N="refline" T="Line" D="Reference Line">
            <O N="R1" T="Point" X="0" Y="0" Z="Topelevation" />
            <O N="R2" T="Point" X="length" Y="width" Z="Topelevation" />
        </O>
    </O>
</O>

When the values of the object to be exported in the Library are written in the "Export" object, it appears in the Source Code in the App, except for the Role="Input" parameters.

To view this example in the library, see(https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidnopmup6rh6fjejdvfax1g&folder=Core+Objects)

  • No labels