Showing:

Annotations
Diagram
Properties
Constraints
Compositions
Used By
Source
Definition InteriorMaterialSet
definitions_InteriorMaterialSet.html#/definitions/InteriorMaterialSet/properties/Name definitions_InteriorMaterialSet.html#/definitions/InteriorMaterialSet/properties/TargetSet definitions_InteriorMaterialSet.html#/definitions/InteriorMaterialSet/properties/SampleSet
Annotations
Title  InteriorMaterialSet

Description  A set of sample materials to randomly assign to a set of interior target elements.

The target set determines *what rooms* receive the materials in the sample
set. The targets in a room are the walls and flooring. Rooms may be targeted
by room type or room name.

The sample set determines *what materials* to randomly select for the
target rooms' walls and floors.

The sample set is optional and when not specified (null) materials are
randomly selected according to the room type for each room in the target
set.

A sample set with an empty material set is invalid since all wall
and flooring targets require materials.
Diagram
Type object
Properties
Name Occurrence
Name
TargetSet
SampleSet
required
required
optional
Additional Properties false
Used by
Source

 "InteriorMaterialSet": {
  "type": "object",
  "additionalProperties": false,
  "title": "InteriorMaterialSet",
  "description": "A set of sample materials to randomly assign to a set of interior target elements.\n\nThe target set determines *what rooms* receive the materials in the sample\nset. The targets in a room are the walls and flooring. Rooms may be targeted\nby room type or room name.\n\nThe sample set determines *what materials* to randomly select for the\ntarget rooms' walls and floors.\n\nThe sample set is optional and when not specified (null) materials are\nrandomly selected according to the room type for each room in the target\nset.\n\nA sample set with an empty material set is invalid since all wall\nand flooring targets require materials.",
  "required": [
    "Name",
    "TargetSet"
  ],
  "properties": {
    "Name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_\\- ]*$",
      "title": "Name"
    },
    "TargetSet": {
      "title": "Targetset",
      "anyOf": [
        {
          "type": "string",
          "const": "Target.All"
        },
        {
          "anyOf": [
            {"$ref": "#/definitions/RoomNameList"},
            {"$ref": "#/definitions/RoomTypeList"}
          ]
        }
      ]
    },
    "SampleSet": {"$ref": "#/definitions/MaterialSetByMaterialType"}
  }
}


Definition Name
Annotations
Title  Name

Diagram
Type string
Constraints
Min Length : 1

Max Length : 255
Pattern : ^[a-zA-Z0-9_\- ]*$

Used by
Source

 "Name": {
  "type": "string",
  "minLength": 1,
  "maxLength": 255,
  "pattern": "^[a-zA-Z0-9_\\- ]*$",
  "title": "Name"
}


Definition TargetSet
#/definitions/InteriorMaterialSet/properties/TargetSet/anyOf/0 #/definitions/InteriorMaterialSet/properties/TargetSet/anyOf/1
Annotations
Title  Targetset

Diagram
Type object
Any of
Additional Properties false
Used by
Source

 "TargetSet": {
  "title": "Targetset",
  "anyOf": [
    {
      "type": "string",
      "const": "Target.All"
    },
    {
      "anyOf": [
        {"$ref": "#/definitions/RoomNameList"},
        {"$ref": "#/definitions/RoomTypeList"}
      ]
    }
  ]
}


Definition anyOf/0
Diagram
Type string
Used by
Source

{
  "type": "string",
  "const": "Target.All"
}


Definition anyOf/1
#/definitions/InteriorMaterialSet/properties/TargetSet/anyOf/1/anyOf/0 #/definitions/InteriorMaterialSet/properties/TargetSet/anyOf/1/anyOf/1
Diagram
Type object
Any of
Additional Properties false
Used by
Source

{
  "anyOf": [
    {"$ref": "#/definitions/RoomNameList"},
    {"$ref": "#/definitions/RoomTypeList"}
  ]
}


Definition anyOf/0
definitions_RoomNameList.html#/definitions/RoomNameList
Diagram
Type reference
Refers RoomNameList
Used by
Source

{"$ref": "#/definitions/RoomNameList"}


Definition anyOf/1
definitions_RoomTypeList.html#/definitions/RoomTypeList
Diagram
Type reference
Refers RoomTypeList
Used by
Source

{"$ref": "#/definitions/RoomTypeList"}


Definition SampleSet
definitions_MaterialSetByMaterialType.html#/definitions/MaterialSetByMaterialType
Diagram
Type reference
Refers MaterialSetByMaterialType
Used by
Source

 "SampleSet": {"$ref": "#/definitions/MaterialSetByMaterialType"}