org.primordion.xholon.service.mathscieng

Class Quantity

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.xholon.service.mathscieng.Quantity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, IQuantity, IXholon, XholonMarker

public class Quantity
extends Xholon
implements IQuantity

Quantity encapsulates 2 private inner classes, one that handles scalars and the other that handles vectors. Quantity determines at runtime which inner class to instantiate, based on how many values are in the text in the XML. It requires the JScience library. Examples:

  <Length>10.0 m</Length> is a scalar
  <Length>10.0 20.0 m</Length> is a vector

Since:

0.8.1 (Created on January 15, 2012)

See Also:

Xholon Project website, JScience, Serialized Form

Field Summary

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL

Constructor Summary

Constructors

Constructor and Description
Quantity()

Method Summary

Methods

Modifier and Type	Method and Description
void	decVal(double val) Decrement an internal double value by a specified amount.
java.lang.String	getDimension() Get Dimension.
java.lang.Object	getInstance()
java.lang.String	getRoleName() Get name of the role played by this Xholon within a specific context.
java.lang.String	getStandardUnit() Get Standard Unit.
java.lang.String	getUnit() Get Unit.
int	getVal_int() Get the value of a "int" maintained by this xholon instance.
long	getVal_long() Get the value of a "long" maintained by this xholon instance.
java.lang.Object	getVal_Object() Get the value of a "Object" maintained by this xholon instance.
java.lang.String	getVal_String() Get the value of a "String" maintained by this xholon instance.
double	getVal() Get the value of a "double" maintained by this xholon instance.
double	getValueN(int index) Get a specified value from the array of magnitudes for this scalar or vector.
double[]	getValues() Get the array of magnitudes for this scalar or vector.
void	incVal(double val) Increment an internal double value by a specified amount.
void	postConfigure() Perform some action, typically once at start up; MAY be overridden.
void	setRoleName(java.lang.String roleName) Set name of the role played by this Xholon within a specific context.
void	setVal(double val) Set the value of a "double" maintained by this xholon instance.
void	setVal(int val) Set the value of a "int" maintained by this xholon instance.
void	setVal(long val) Set the value of a "long" maintained by this xholon instance.
void	setVal(java.lang.Object val) Set the value of a "Object" maintained by this xholon instance.
void	setVal(java.lang.String val) Set the value of a "String" maintained by this xholon instance.
java.lang.String	toString()

Methods inherited from class org.primordion.xholon.base.Xholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, configure, consoleLog, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_short, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, getXPath, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, searchForReferencingNodesRecurse, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Quantity

public Quantity()

Method Detail

postConfigure

public void postConfigure()

Description copied from interface: IXholon

Perform some action, typically once at start up; MAY be overridden. Recursive; application should call this only for root.

Specified by:

postConfigure in interface IXholon

Overrides:

postConfigure in class Xholon

getVal_Object

public java.lang.Object getVal_Object()

Description copied from interface: IXholon

Get the value of a "Object" maintained by this xholon instance.

Specified by:

getVal_Object in interface IXholon

Overrides:

getVal_Object in class Xholon

setVal

public void setVal(java.lang.Object val)

Description copied from interface: IXholon

Set the value of a "Object" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

getVal_String

public java.lang.String getVal_String()

Description copied from interface: IXholon

Get the value of a "String" maintained by this xholon instance.

Specified by:

getVal_String in interface IXholon

Overrides:

getVal_String in class Xholon

setVal

public void setVal(java.lang.String val)

Description copied from interface: IXholon

Set the value of a "String" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

getVal

public double getVal()

Description copied from interface: IXholon

Get the value of a "double" maintained by this xholon instance. If a class that implements this interface does not maintain such a value, it should return 0.0 This method can be used in place of getVal_double()

Specified by:

getVal in interface IXholon

Overrides:

getVal in class Xholon

Returns:

A double value.

setVal

public void setVal(double val)

Description copied from interface: IXholon

Set the value of a "double" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

Parameters:

val - The new value.

incVal

public void incVal(double val)

Description copied from interface: IXholon

Increment an internal double value by a specified amount. This is a convenience method.

Specified by:

incVal in interface IXholon

Overrides:

incVal in class Xholon

Parameters:

val - Increment amount.

decVal

public void decVal(double val)

Description copied from interface: IXholon

Decrement an internal double value by a specified amount. This is a convenience method.

Specified by:

decVal in interface IXholon

Overrides:

decVal in class Xholon

Parameters:

val - Decrement amount.

getVal_long

public long getVal_long()

Description copied from interface: IXholon

Get the value of a "long" maintained by this xholon instance.

Specified by:

getVal_long in interface IXholon

Overrides:

getVal_long in class Xholon

setVal

public void setVal(long val)

Description copied from interface: IXholon

Set the value of a "long" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

getVal_int

public int getVal_int()

Description copied from interface: IXholon

Get the value of a "int" maintained by this xholon instance.

Specified by:

getVal_int in interface IXholon

Overrides:

getVal_int in class Xholon

setVal

public void setVal(int val)

Description copied from interface: IXholon

Set the value of a "int" maintained by this xholon instance.

Specified by:

setVal in interface IXholon

Overrides:

setVal in class Xholon

getUnit

public java.lang.String getUnit()

Description copied from interface: IQuantity

Get Unit.

Specified by:

getUnit in interface IQuantity

Returns:

The String representation of a JScience Unit, or equivalent.

getStandardUnit

public java.lang.String getStandardUnit()

Description copied from interface: IQuantity

Get Standard Unit.

Specified by:

getStandardUnit in interface IQuantity

Returns:

The String representation of a JScience Standard Unit, or equivalent.

getDimension

public java.lang.String getDimension()

Description copied from interface: IQuantity

Get Dimension.

Specified by:

getDimension in interface IQuantity

Returns:

The String representation of a JScience Dimension, or equivalent.

getValues

public double[] getValues()

Description copied from interface: IQuantity

Get the array of magnitudes for this scalar or vector.

Specified by:

getValues in interface IQuantity

Returns:

An array of double values. For a scalar or 1D vector, there will be 1 values (typically X). For a 2D vector, there will be 2 values (typically X Y). For a 3D vector, there will be 3 values (typically X Y Z). For an n-dimensional vector, there will be n values.

getValueN

public double getValueN(int index)

Description copied from interface: IQuantity

Get a specified value from the array of magnitudes for this scalar or vector.

Specified by:

getValueN in interface IQuantity

Parameters:

index - The index of the requested magnitude. Index must be >= 0, and < the dimension of the vector. For a scalar or 1D vector, index is assumed to be == 0 and is not checked. For a 2D vector, 0 <= index < 2 .

Returns:

The value associated with that index.

toString

public java.lang.String toString()

Overrides:

toString in class Xholon

getRoleName

public java.lang.String getRoleName()

Description copied from interface: IXholon

Get name of the role played by this Xholon within a specific context.

Specified by:

getRoleName in interface IXholon

Overrides:

getRoleName in class Xholon

Returns:

A name that identifies the role, or null.

setRoleName

public void setRoleName(java.lang.String roleName)

Description copied from interface: IXholon

Set name of the role played by this Xholon within a specific context.

Specified by:

setRoleName in interface IXholon

Overrides:

setRoleName in class Xholon

Parameters:

roleName - An optional name that identifies the role.

getInstance

public java.lang.Object getInstance()