EquipmentHolder

: Public abstract <<TMF_BusinessEntity>> Business Entity

Created:	1/10/2022 12:01:10 PM
Modified:	4/15/2022 10:27:43 AM

Project:
Author:	Giu Platania
Version:	22.0
Phase:	prop
Status:	Implemented
Complexity:	Easy
Difficulty:
Priority:
Multiplicity:
Advanced:
UUID:	{F33A38A6-AA40-4786-8F82-8C05A4F13249}
Appears In:	Figure PR.02 - (PR.04, PR.05) - Different Aspects of a Device - Illustrative, Figure PR.04 - The Makeup of a Device - Illustrative, Figure PR.05 - The Concept of “Holding” Hardware - Illustrative, Figure PR.06 - Our Simple Example Router - Illustrative, Figure PR.17 - PhysicalContainer in More Detail, Figure PR.20 - Specifying Different Types of EquipmentHolders, Figure PR.21 - HolderAtomic in More Detail, Figure PR.22 - HolderComposite in More Detail, Figure PR.25 - Relating PhysicalPorts to Cards and Chassis, UNUSED Figure PR.44 - PhysicalPort Business Entity Model, UNUSED Figure PR.45 - Equipment Business Entity Model, UNUSED Figure PR.47 - EquipmentHolder Business Entity Model, UNUSED Figure PR.53 - AuxiliaryComponent Business Entity Model, UNUSED Figure PR.56 - PhysicalComponent Business Entity Model, UNUSED Figure PR.48 - HolderAtomic Business Entity Model, UNUSED Figure PR.49 - Slot Business Entity Model, UNUSED Figure PR.50 - HolderComposite Business Entity Model, UNUSED Figure PR.51 - SecureHolder Business Entity Model, UNUSED Figure PR.54 - CoolingDevice and Fan Business Entity Model, UNUSED Figure PR.55 - PowerSupply Business Entity Model, UNUSED Figure PR.57 - Chip, ASIC, and MemoryComponent Business Entity Model, Figure PR.KD01 - Resource, UNUSED Figure PR.41 - PhysicalContainer Business Entity Model, Router, Equipment Holder Summary

This class is based on the M.3100 specification, and is a base class that represents physical objects that are both manageable as well as able to host, hold, or contain other physical objects. Examples of physical objects that can be represented by instances of this object class are Racks, Chassis, Shelfs, and Slots. The difference between subclasses of EquipmentHolder (such as a Slot or a Chassis) and subclasses of Equipment that have a Holder role (such as a Card) is that the subclasses of EquipmentHolder are dedicated to holding other Hardware. The subclasses of Equipment that have a holder role have a holding capability as a secondary capability, usually for expansion. Their primary function, however, is not to hold other objects.

Attributes
Associations To
Associations From
Tagged Values
Advanced
Other Links

Attribute

Public String
acceptableEquipmentList

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This is an array of strings, based on M.3100, that identifies the types of equipment objects that can be supported by this object. This is an optional attribute.

Public const String
acceptableEquipmentTypeList

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute identifies the types of equipment that can be supported by the Equipment Holder.

Public ObjectName
asapRef

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute indicates the assignment of an Alarm Severity Assignment Profile (ASAP) to the EquipmentHolder.

Public const ObjectName
expectedOrInstalledEquipmentRef

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute identifies the equipment object expected or installed in the equipment holder, if any. Null if the equipment holder is empty or if it only contains other equipment holders.

Public Integer
holderStatus

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute, based on M.3100, indicates the status of the EquipmentHolder. Values include: 0: Unknown 1: Installed And Acceptable 2: Installed And Not Acceptable 3: Not Installed 4: Mismatch Of Installed and Acceptable 5: Unavailable This is an optional attribute.

Public Boolean
isReportingAlarms

Details:

Alias:
Initial:	true
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute provides an indication of whether alarm reporting for this Equipment Holder is enabled (true) or disabled (false).

Public Boolean
isSolitaryHolder

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This is a Boolean attribute that, if TRUE, defines this EquipmentHolder as containing only one ManagedComponent. If this is FALSE, then this EquipmentHolder contains nested ManagedComponents. This is a REQUIRED attrinbute.

Public ItuArcStateAndStatusList
ituArcStateAndStatusList

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:	Range:0 to 1
Transient:	False
Derived:	False
IsID:	False

Notes:

See R_TMF518_NRB_I_0001 and R_TMF518_NRB_I_0004. See supporting document SD1-8_encodingX731M3100...\..\Framework\SD\SD1-8_encodingX731M3100.pdf

Public const String
manufacturer

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute identifies the Equipment Holder manufacturer name. It is defined as a non-empty free format string with no semantics.

Public const String
state

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute identifies the state of the Equipment Holder.

Public const String
type

Details:

Alias:
Initial:
Stereotype:	<<required>>
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This attribute identifies the type of the Holder (e.g., Rack (or Bay), Shelf, Sub-shelf, Slot, Subslot, Remote-unit or Remote-subslot).

Public Integer
typeOfHolder

Details:

Alias:
Initial:
Stereotype:
Ordered:
Range:
Transient:	False
Derived:	False
IsID:	False

Notes:

This is an enumerated integer that identifies the type of the Holder that this object instance is. It is based on M.3100 but includes additional values: 0: Unknown 1: Rack 2: Bay 3: Chassis 4: Shelf 5: Slot 6: Sub-Slot 7: Sub-Rack This is a REQUIRED attribute.

Element	Source Role	Target Role
«TMF_ABE» Equipment Holder ABE ABE «TMF_ABEIsComposedByEntity»	Name:	Name:
Details:
«TMF_BusinessEntity» Equipment Business Entity	Name: _equipmentHolder	Name: _equipment
Details:
«TMF_BusinessEntity» Hardware Business Entity	Name: _equipmentHolder2	Name: _hardware2
Details:

Element	Source Role	Target Role
«TMF_BusinessEntity» HolderComposite Business Entity	Name: _holderComposite	Name: _equipmentHolder3
Details:

Tag	Value
IsCoreEntity	False
Details: Values: true,false Default: False
rsa_guid	_3E3F0EC000E93DDEEA6B0245
Details:

Property	Value
isActive:	0
isFinalSpecialization:	0

Object	Type	Connection	Direction	Notes
«TMF_BusinessEntity» PhysicalContainer	Business Entity	Generalization	To
HolderComposite	Business Entity	Generalization	From
HolderAtomic	Business Entity	Generalization	From