Hydrologic Formation Storage Type in ESG data model

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"4.3"	string	semantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en A type of event that is associated with outage. Example: Active Storage Capacity Conservation Storage Capacity Dead Storage Capacity Exclusive Flood Control Storage Capacity Inactive Storage Capacity Joint Use Storage Capacity Live Storage Capacity Sediment Storage Capacity Surcharge Storage Capacity Total Storage Capacity Usable Storage Active Storage Conservation Storage Gross Storage Available Capacity where: Active Storage Capacity The volume of water normally available for release from a reservoir below the stage of the maximum controllable level; equal to total capacity less inactive and dead capacity. Conservation Storage Capacity Storage capacity available for all useful purposes such as municipal water supply, power, irrigation, recreation, fish and wildlife, etc., excluding joint and exclusive flood control capacity. Dead Storage Capacity The volume of a reservoir below the sill or invert of the lowest outlet. Exclusive Flood Control Storage Capacity The space in reservoirs reserved for the sole purpose of regulating flood inflows to abate flood damage. Inactive Storage Capacity The portion of capacity below which the reservoir is not normally drawn, and which is provided for sedimentation, recreation, fish and wildlife, aesthetic reasons, or for creation of a minimum controlled operational or power head in compliance with operating agreements or restrictions. Joint Use Storage Capacity The volume of a reservoir available to store water jointly for flood control and conservation purposes. Live Storage Capacity The volume of a reservoir exclusive of dead and surcharge capacity. Sediment Storage Capacity The volume of a reservoir planned for the deposition of sediment. Surcharge Storage Capacity The volume of a reservoir between the maximum water surface elevation for which the dam is designed and the crest of an uncontrolled spillway, or the normal full-pool elevation with the crest gates in the normal closed position. Total Storage Capacity The total volume of a reservoir exclusive of surcharge Usable Storage The volume of water normally available for release from a reservoir below the stage of the maximum controllable level. Active Storage The total amount of usable reservoir capacity available for seasonal or cyclic water storage. It's gross reservoir capacity minus inactive storage capacity. Conservation Storage "The portion of water stored in a reservoir that can be later released for useful purposes such as municipal water supply, power, or irrigation. Conservation storage is the volume of water stored between dead reservoir storage and flood control storage." Gross Storage Available Capacity The total amount of storage capacity available in a reservoir for all purposes, from the streambed to the normal maximum operating level. It does not include surcharge (water temporarily stored above the elevation of the top of the spillway), but does include dead (or inactive) storage.	entity	a reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	HydrologicFormationStorageType/(resolvedAttributes)/HydrologicFormationStorageTypeId	attribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

Parameter	Value	Data type	Explanation
versionNumber	"1.2.3"	string

is.IDM.modelVersion
Semantic version number of the IDM.

Parameter	Value	Data type	Explanation
versionNumber	"1.6.0"	string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{B9B472CC-7F66-423D-A632-3AFCB60AC42F}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

Parameter	Value	Data type	Explanation
name	"Water Management"	string

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Hydrologic Formation Storage Type	entity	a reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
HydrologicFormationStorageTypeId	The unique identifier of a hydrologic formation storage type.	HydrologicFormationStorageType
HydrologicFormationStorageTypeName	The name of a hydrologic formation storage type.	HydrologicFormationStorageType
HydrologicFormationStorageTypeDescription	The description of a hydrologic formation storage type.	HydrologicFormationStorageType

HydrologicFormationStorageTypeId

The unique identifier of a hydrologic formation storage type.
First included in: HydrologicFormationStorageType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Storage Type ID
description	The unique identifier of a hydrologic formation storage type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the HydrologicFormationStorageTypeId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	HydrologicFormationStorageType/(resolvedAttributes)/HydrologicFormationStorageTypeId	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{DA671C06-C1CA-44F4-BF40-1D1772BDFBC1}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Hydrologic Formation Storage Type ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a hydrologic formation storage type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

HydrologicFormationStorageTypeName

The name of a hydrologic formation storage type.
First included in: HydrologicFormationStorageType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Storage Type Name
description	The name of a hydrologic formation storage type.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the HydrologicFormationStorageTypeName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{A079C817-F780-4E2F-8898-683F1609837E}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Hydrologic Formation Storage Type Name	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of a hydrologic formation storage type.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"256"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

HydrologicFormationStorageTypeDescription

The description of a hydrologic formation storage type.
First included in: HydrologicFormationStorageType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Storage Type Description
description	The description of a hydrologic formation storage type.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the HydrologicFormationStorageTypeDescription attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{3A37FCA1-8C50-4107-BB7A-A5A43A0A6668}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Hydrologic Formation Storage Type Description	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The description of a hydrologic formation storage type.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"2048"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.