Skip to content

Commit 0d3a545

Browse files
authored
Merge pull request #82 from one-data-model/F2FD3
odmThing syntax definition
2 parents 10662be + 3365037 commit 0d3a545

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

sdf.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ This document describes definitions of OneDM Objects and their associated Events
1010

1111
The JSON format of an SDF definition is described in this document.
1212

13+
## Defined Terms
14+
15+
Note: Should we use RFC 2119?
16+
17+
Quality
18+
- a metadata item in a definition or declaration which says something about that definition or declaration. A quality is represented in SDF as a member in a JSON object that serves as a definition or declaration
19+
20+
Definition
21+
- Creates a new semantic term for use in SDF models and associates it with a set of qualities
22+
23+
Declaration
24+
- A reference to and a use of a definition within an enclosing definition, intended to create component instances within that enclosing definition.
25+
26+
## Conventions
27+
28+
- The singular form is preferred for keywords.
29+
1330
## Example Definition:
1431
```json
1532
{
@@ -458,11 +475,11 @@ odmView may define or include the following odmTypes:
458475

459476
### odmThing
460477

461-
An odmThing is a potentially reusable composition of objects that is part of a more complex model. For example, the objects that make up the definition of a single plug of an outlet strip could be encapsulated by a component.
478+
An odmThing is a set of declarations and qualities that may be part of a more complex model. For example, the object declarations that make up the definition of a single socket of an outlet strip could be encapsulated in an odmThing, and the socket-thing itself could be used in a declaration in the odmThing definition for the outlet strip.
462479

463-
Thing definitions work much like Object definitions, except that a Thing is composed of Objects. Thing definitions may use odmInclude for Object definitions from elsewhere, or Thing definitions may use odmInclude for their own Object definitions, as well as reusable Property, Action, and Event definitions that can be used to extend or complete the Object definitions.
480+
odmThing definitions carry semantic meaning, such as a defined refrigerator compartment and a defined freezer compartment, making up a combination referigerator-freezer product.
464481

465-
Thing definitions carry semantic meaning, such as a defined refrigerator compartment and a defined freezer compartment, making up a combination refer-freezer product.
482+
An odmThing may be composed of odmObjects and other odmThings.
466483

467484
- Qualities of odmThing
468485

0 commit comments

Comments
 (0)