wwndesc  1.0-76
HDSModularDescription Class Reference

HDSModularDescription (ie HDS-D850-31787-CTL0-PortD) breaks out the model type, serial, and FA port from the WWPN. More...

Inheritance diagram for HDSModularDescription:
Collaboration diagram for HDSModularDescription:

Public Member Functions

 HDSModularDescription (String wwn)
 create an instance with brief set to false. More...
 
 HDSModularDescription (boolean brief, String wwn)
 create an instance with the given WWN. More...
 
String toString ()
 return a description or alias for this WWN; if brief is set to true during the call to getDesc(), then a shorter description or alias will be returned More...
 
- Public Member Functions inherited from WWNDesc.WWNDescTarget
 WWNDescTarget (String wwn)
 create an instance with brief set to false. More...
 
 WWNDescTarget (boolean brief, String wwn)
 create an instance with the given WWN. More...
 
- Public Member Functions inherited from WWNDesc
 WWNDesc (String wwn)
 create an instance with brief set to false. More...
 
 WWNDesc (boolean brief, String wwn)
 create an instance with the given WWN. More...
 
 WWNDesc (boolean brief, String wwn, DevRole role)
 create an instance with the given WWN. More...
 
String descPort ()
 describe the WWPN's unique port label/index More...
 
String toString ()
 describe the WWN: produce a short (shorter if this.brief = true) description suitable for use as an alias for this WWN More...
 

Static Public Member Functions

static WWNDesc getDesc (boolean strong, boolean brief, String wwn)
 If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN. More...
 
static WWNDesc getDesc (boolean strong, boolean brief, String wwn, int role)
 If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN. More...
 
- Static Public Member Functions inherited from WWNDesc.WWNDescTarget
static boolean isA (int role)
 convenience function to use bit-masks to check for membership in this role More...
 

Additional Inherited Members

- Protected Attributes inherited from WWNDesc
boolean brief
 whether a more brief output should be offered in toString() (ie the difference between "VMax-HK192601234-12gB" and "VMax-1234-12gB") . More...
 
DevRole role = DevRole.TARGET
 role of the device: Target, Switch, Initiator
 
BigInteger wwn
 the WWN that the instance tried to describe
 

Detailed Description

HDSModularDescription (ie HDS-D850-31787-CTL0-PortD) breaks out the model type, serial, and FA port from the WWPN.

Definition at line 14 of file HDSModularDescription.java.

Constructor & Destructor Documentation

HDSModularDescription ( String  wwn)
inline

create an instance with brief set to false.

This is a convenience function to support the older constructor model

Exceptions
java.lang.NullPointerExceptionif the given wwn is null
Parameters
wwnthe WWN to evaluate and describe

Definition at line 17 of file HDSModularDescription.java.

Referenced by HDSModularDescription.getDesc().

HDSModularDescription ( boolean  brief,
String  wwn 
)
inline

create an instance with the given WWN.

Values given to the constructor are simply copied to internal variables for later use

Exceptions
java.lang.NullPointerExceptionif the given wwn is null
Parameters
briefwhether an abbreviated description is requested
wwnthe WWN to evaluate and describe

Definition at line 22 of file HDSModularDescription.java.

Member Function Documentation

static WWNDesc getDesc ( boolean  strong,
boolean  brief,
String  wwn 
)
inlinestatic

If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN.

This function should correspond to HDSVSPDescription::getDesc(boolean, boolean, String) as both are redundant copies simply to avoid an error ustream being leaked out to the user

Returns
new instance of this class, or null if the given wwn does not match this class
Parameters
strongis ignored: this class is a strong representation, not a weak one based on empirical matching, hence can always be used with confidence
briefis used to ask for a shorter description: a more concise nickname or alias
wwnthe WWN (WWPN or WWNN, but typically WWPN) to match

Definition at line 38 of file HDSModularDescription.java.

References DevRole.max.

static WWNDesc getDesc ( boolean  strong,
boolean  brief,
String  wwn,
int  role 
)
inlinestatic

If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN.

This function should correspond to HDSVSPDescription::getDesc(boolean, boolean, String) as both are redundant copies simply to avoid an error ustream being leaked out to the user

Returns
new instance of this class, or null if the given wwn does not match this class
Parameters
strongis ignored: this class is a strong representation, not a weak one based on empirical matching, hence can always be used with confidence
briefis used to ask for a shorter description: a more concise nickname or alias
wwnthe WWN (WWPN or WWNN, but typically WWPN) to match
roleRole (Initiator/Switch/Target) to check for

Definition at line 46 of file HDSModularDescription.java.

References HDSModularDescription.HDSModularDescription(), and WWNDesc.WWNDescTarget.isA().

Here is the call graph for this function:

String toString ( )
inline

return a description or alias for this WWN; if brief is set to true during the call to getDesc(), then a shorter description or alias will be returned

See also
getDesc(boolean,boolean,String)
Returns
generated alias or nickname for the WWN

010 TOM: HDS KA15062: breaks it up as N OOOOOO FFF S ssss P (N=5, OOOOOO = OUI, FFF = Family (010) ssss=Serial % 0x10000, P=Port (0-F) need to check against http://p2v.it/tools/wwndec/index.php?input=50060e8010139322 need to check http://p2v.it/tools/wwndec/index.php?input=50060e8010139322

Definition at line 65 of file HDSModularDescription.java.

References WWNDesc.brief, and WWNDesc.wwn.


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