ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-04-13 22:23:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Core] Add JSDoc for ContextCapability

Browse Source 
Add JSDoc for the 'context' capability; part of
ongoing documentation to meet code standards in
platform/core in preparation for integration.
WTD-573.
This commit is contained in:
Victor Woeltjen 2014-11-20 13:51:29 -08:00
parent 5a437a7124
commit e569249231
1 changed files with 47 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
platform/core/src/capabilities/ContextCapability.js
View File

@ -9,17 +9,49 @@ define(
"use strict";
/**
* The `context` capability of a domain object (retrievable with
* `domainObject.getCapability("context")`) allows an object's
* hierarchical parents and ancestors to be retrieved (specifically,
* those whose `composition` capability was used to access this
* object.)
*
* @constructor
*/
function ContextCapability(parentObject, domainObject) {
var self,
parentObject;
self = {
return {
/**
* Get the immediate parent of a domain object.
*
* A domain object may be contained in multiple places; its
* parent (as exposed by this capability) is the domain
* object from which this object was accessed, usually
* by way of a `composition` capability.
*
* @returns {DomainObject} the immediate parent of this
* domain object.
*/
getParent: function () {
return parentObject;
},
/**
* Get an array containing the complete direct ancestry
* of this domain object, including the domain object
* itself.
*
* A domain object may be contained in multiple places; its
* parent and all ancestors (as exposed by this capability)
* serve as a record of how this specific domain object
* instance was reached.
*
* The first element in the returned array is the deepest
* ancestor; subsequent elements are progressively more
* recent ancestors, with the domain object which exposed
* the capability occupying the last element of the array.
*
* @returns {DomainObject[]} the full composition ancestry
* of the domain object which exposed this
* capability.
*/
getPath: function () {
var parentPath = [],
parentContext;
@ -33,18 +65,22 @@ define(
return parentPath.concat([domainObject]);
},
/**
* Get the deepest ancestor available for this domain object;
* equivalent to `getPath()[0]`.
*
* See notes on `getPath()` for how ancestry is defined in
* the context of this capability.
*
* @returns {DomainObject} the deepest ancestor of the domain
* object which exposed this capability.
*/
getRoot: function () {
return self.getPath()[0];
return this.getPath()[0];
}
};
return self;
}
ContextCapability.appliesTo = function () {
return true;
};
return ContextCapability;
}
);