GridLab
Grid Application Toolkit

A simple API for Grid Applications
GAT

Menu



Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

resources::HardwareResourceDescription Class Reference

An instance of this class is a description of a hardware resource, a physical thing, which a may be required by a hardware or software component. More...

Inheritance diagram for resources::HardwareResourceDescription:

Inheritance graph
[legend]
Collaboration diagram for resources::HardwareResourceDescription:

Collaboration graph
[legend]
List of all members.

Public Methods

 HardwareResourceDescription (Map hardwareResourceDescription, List softwareResourceDescriptions, List hardwareResourceDescriptions)
 Constructs a HardwareResourceDescription associated with the passed objects:.

boolean equals (Object object)
 Tests this HardwareResourceDescription for equality with the passed Object.

Map getDescription ()
 Returns the HardwareResourceDescription of this instance.

void setDescription (Map hrd)
 Sets the HardwareResourceDescription of this instance.

void addResourceAttribute (String name, Object value)
 Adds the name/value pair to the java.util.Map of name/value pairs which describe the "parent" hardware component.

void removeResourceAttribute (String name) throws NoSuchElementException
 Removes the name/value pair with the passed name from the java.util.Map of name/value pairs which describe the "parent" hardware component.

void addResourceDescription (ResourceDescription hardwareResourceDescription)
 Adds the passed HardwareResourceDescription to the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

void removeResourceDescription (ResourceDescription hardwareResourceDescription)
 Removes the passed HardwareResourceDescription from the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

void setHardwareResourceDescriptions (List hardwareResourceDescriptions)
 Sets the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription to the passed java.util.List.

List getHardwareResourceDescriptions ()
 Gets the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

void addSoftwareResourceDescription (SoftwareResourceDescription softwareResourceDescription)
 Adds the passed SoftwareResourceDescription to the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

void removeSoftwareResourceDescription (SoftwareResourceDescription softwareResourceDescription)
 Removes the passed SoftwareResourceDescription from the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

void setSoftwareResourceDescriptions (List softwareResourceDescriptions)
 Sets the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription to the passed java.util.List.

List getSoftwareResourceDescriptions ()
 Gets the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.


Private Attributes

Map hardwareResourceDescription = null
 This member variable holds the Map which describes the "parent" hardware component.

List softwareResourceDescriptions = null
 This member variable holds a List of SoftwareResourceDescription's describing each of which describes a software component upon which the "parent" hardware component depends.

List hardwareResourceDescriptions = null
 This member variable holds a List of HardwareResourceDescription's describing each of which describes a hardware component upon which the "parent" hardware component depends.


Detailed Description

An instance of this class is a description of a hardware resource, a physical thing, which a may be required by a hardware or software component.

To clarify the concept of a HardwareResourceDescription, let us give various examples. Memory is described by a HardwareResourceDescription; a network is described by a HardwareResourceDescription; disk space is described by a HardwareResourceDescription; a monitor is described a HardwareResourceDescription\ldots However, an application is not described by a HardwareResourceDescription. In general any resource which corresponds to a physical thing is described by a HardwareResourceDescription.

Hardware is generally useless without software. For example, a disk drive without the appropriate software driver is all but useless. Similarly, hardware often depends upon other hardware. For example, having a disk drive without a computer again is not of much use. Hence, in describing a hardware component one needs to also describe the software and hardware that this hardware component requires. This is reflected in the fact that a HardwareResourceDescription contains in addition to a description of a hardware component a list of HardwareResourceDescriptions, each element of which describes a hardware component upon which the parent hardware component depends, and a list of SoftwareResourceDescriptions, each element of which describes a software component upon which the parent hardware component depends. Hence, the entire structure is recursive.

To construct an instance of a HardwareResourceDescription one requires three quantities:

  • A map which contains a set of name/value pairs, detailed later, which describe a hardware resource.
  • A list of SoftwareResourceDescription instances each of which describes a software resource upon which the parent hardware resource depends. A list of HardwareResourceDescription instances each of which describes a hardware resource upon which the parent hardware resource depends.
The GAT-API defines a minimum set of supported name/value pairs which can be included in the java.util.Map used to construct a HardwareResourceDescription instance. This minimum set of name/value pairs MUST be supported by any implementation of the GAT-API. This minimum set of supported name/values is given in the table

<TABLE border="2" frame="box" rules="groups" summary="Minimum set of supported name/value pairs"> <COLGROUP align="left"> <COLGROUP align="center"> <COLGROUP align="left" > <THEAD valign="top"> <TH>Name <TH>Type <TH>Description <TBODY> memory.size java.lang.Float The minimum memory in GB. memory.accesstime java.lang.Float The minimum memory access time in ns. memory.str java.lang.Float The minimum sustained transfer rate in GB/s. machine.type java.lang.String The machine type as returned from uname -m machine.node java.lang.String The machine node as returned from uname -n cpu.type java.lang.String The generic cpu type as returned from uname -p cpu.speed java.lang.Float The minimum cpu speed in GHz. disk.size java.lang.Float The minimum size of the hard drive in GB. disk.accesstime java.lang.Float The minimum disk access time in ms. disk.str java.lang.Float The minimum sustained transfer rate in MB/s. <TBODY>

Definition at line 103 of file HardwareResourceDescription.java.


Constructor & Destructor Documentation

resources::HardwareResourceDescription::HardwareResourceDescription Map    hardwareResourceDescription,
List    softwareResourceDescriptions,
List    hardwareResourceDescriptions
[inline]
 

Constructs a HardwareResourceDescription associated with the passed objects:.

  • HardwareResourceDescription --- A java.util.Map, which describes the "parent" hardware component.
  • SoftwareResourceDescriptions --- A java.util.List, which is a list of SoftwareResourceDescriptions each of which describes a software component upon which the "parent" hardware component depends.
  • HardwareResourceDescriptions --- A java.util.List, which is a list of HardwareResourceDescriptions each of which describes a hardware component upon which the "parent" hardware component depends.
Parameters:
hardwareResourceDescription  A java.util.Map, which describes the "parent" hardware component.
softwareResourceDescriptions  A java.util.List, which is a list of SoftwareResourceDescriptions each of which describes a software component upon which the "parent" hardware component depends.
hardwareResourceDescriptions  A java.util.List, which is a list of HardwareResourceDescriptions each of which describes a hardware component upon which the "parent" hardware component depends.

Definition at line 150 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription, resources::HardwareResourceDescription::hardwareResourceDescriptions, and resources::HardwareResourceDescription::softwareResourceDescriptions.


Member Function Documentation

boolean resources::HardwareResourceDescription::equals Object    object [inline]
 

Tests this HardwareResourceDescription for equality with the passed Object.

If the given object is not a HardwareResourceDescription, then this method immediately returns false.

If the passed object is a HardwareResourceDescription, then it is deemed equal if it has an equivalent HardwareResourceDescription, as determined by the Equals method on java.util.Map, and an equivalent SoftwareResourceDescriptions, as determined by the Equals method on java.util.List, and an equivalent HardwareResourceDescriptions, as determined by the Equals method on java.util.List.

Parameters:
object  The Object to test for equality
Returns:
A boolean indicating equality

Definition at line 175 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription, resources::HardwareResourceDescription::hardwareResourceDescriptions, and resources::HardwareResourceDescription::softwareResourceDescriptions.

Map resources::HardwareResourceDescription::getDescription   [inline]
 

Returns the HardwareResourceDescription of this instance.

Returns:
The HardwareResourceDescription of this instance

Definition at line 201 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription.

void resources::HardwareResourceDescription::setDescription Map    hrd [inline]
 

Sets the HardwareResourceDescription of this instance.

Parameters:
hrd  The HardwareResourceDescription of this instance

Definition at line 211 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription.

void resources::HardwareResourceDescription::addResourceAttribute String    name,
Object    value
[inline]
 

Adds the name/value pair to the java.util.Map of name/value pairs which describe the "parent" hardware component.

Parameters:
name  The Name, a java.lang.String, to add to the name/value pairs which describe the "parent" hardware component.
value  The Value, an Object, to add to the name/value pairs which describe the "parent" hardware component.

Definition at line 226 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription.

void resources::HardwareResourceDescription::removeResourceAttribute String    name throws NoSuchElementException [inline]
 

Removes the name/value pair with the passed name from the java.util.Map of name/value pairs which describe the "parent" hardware component.

Parameters:
name  The Name, a java.lang.String, to of the name/value pair to remove from the name/value pairs which describe the "parent" hardware component.

Definition at line 239 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription.

void resources::HardwareResourceDescription::addResourceDescription ResourceDescription    hardwareResourceDescription [inline]
 

Adds the passed HardwareResourceDescription to the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Parameters:
hardwareResourceDescription  The HardwareResourceDescription to add to the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 254 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription, and resources::HardwareResourceDescription::hardwareResourceDescriptions.

void resources::HardwareResourceDescription::removeResourceDescription ResourceDescription    hardwareResourceDescription [inline]
 

Removes the passed HardwareResourceDescription from the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Parameters:
hardwareResourceDescription  The HardwareResourceDescription to remove from the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 269 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescription, and resources::HardwareResourceDescription::hardwareResourceDescriptions.

void resources::HardwareResourceDescription::setHardwareResourceDescriptions List    hardwareResourceDescriptions [inline]
 

Sets the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription to the passed java.util.List.

Parameters:
hardwareResourceDescriptions  The new java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 282 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescriptions.

List resources::HardwareResourceDescription::getHardwareResourceDescriptions   [inline]
 

Gets the java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Returns:
The java.util.List of HardwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 294 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::hardwareResourceDescriptions.

void resources::HardwareResourceDescription::addSoftwareResourceDescription SoftwareResourceDescription    softwareResourceDescription [inline]
 

Adds the passed SoftwareResourceDescription to the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Parameters:
softwareResourceDescription  The SoftwareResourceDescription to add to the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 308 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::softwareResourceDescriptions.

void resources::HardwareResourceDescription::removeSoftwareResourceDescription SoftwareResourceDescription    softwareResourceDescription [inline]
 

Removes the passed SoftwareResourceDescription from the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Parameters:
softwareResourceDescription  The SoftwareResourceDescription to remove from the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 323 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::softwareResourceDescriptions.

void resources::HardwareResourceDescription::setSoftwareResourceDescriptions List    softwareResourceDescriptions [inline]
 

Sets the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription to the passed java.util.List.

Parameters:
softwareResourceDescriptions  The new java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 336 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::softwareResourceDescriptions.

List resources::HardwareResourceDescription::getSoftwareResourceDescriptions   [inline]
 

Gets the java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Returns:
The java.util.List of SoftwareResourceDescriptions which describe this HardwareResourceDescription.

Definition at line 348 of file HardwareResourceDescription.java.

References resources::HardwareResourceDescription::softwareResourceDescriptions.


Member Data Documentation

Map resources::HardwareResourceDescription::hardwareResourceDescription = null [private]
 

This member variable holds the Map which describes the "parent" hardware component.

Definition at line 109 of file HardwareResourceDescription.java.

Referenced by resources::HardwareResourceDescription::addResourceAttribute(), resources::HardwareResourceDescription::addResourceDescription(), resources::HardwareResourceDescription::equals(), resources::HardwareResourceDescription::getDescription(), resources::HardwareResourceDescription::HardwareResourceDescription(), resources::HardwareResourceDescription::removeResourceAttribute(), resources::HardwareResourceDescription::removeResourceDescription(), and resources::HardwareResourceDescription::setDescription().

List resources::HardwareResourceDescription::softwareResourceDescriptions = null [private]
 

This member variable holds a List of SoftwareResourceDescription's describing each of which describes a software component upon which the "parent" hardware component depends.

Definition at line 116 of file HardwareResourceDescription.java.

Referenced by resources::HardwareResourceDescription::addSoftwareResourceDescription(), resources::HardwareResourceDescription::equals(), resources::HardwareResourceDescription::getSoftwareResourceDescriptions(), resources::HardwareResourceDescription::HardwareResourceDescription(), resources::HardwareResourceDescription::removeSoftwareResourceDescription(), and resources::HardwareResourceDescription::setSoftwareResourceDescriptions().

List resources::HardwareResourceDescription::hardwareResourceDescriptions = null [private]
 

This member variable holds a List of HardwareResourceDescription's describing each of which describes a hardware component upon which the "parent" hardware component depends.

Definition at line 123 of file HardwareResourceDescription.java.

Referenced by resources::HardwareResourceDescription::addResourceDescription(), resources::HardwareResourceDescription::equals(), resources::HardwareResourceDescription::getHardwareResourceDescriptions(), resources::HardwareResourceDescription::HardwareResourceDescription(), resources::HardwareResourceDescription::removeResourceDescription(), and resources::HardwareResourceDescription::setHardwareResourceDescriptions().


The documentation for this class was generated from the following file: