Instance.PropertyAtom

Description

Utility functions to operate on PropertyAtom properties

Functions

NameSignature and Synopsis
getBooleanboolean getBoolean (PropertyAtomBoolean propertyAtomBoolean, long time)
Gets the value of the PropertyAtomBoolean at a particular time.
getBooleanHistoryValueboolean getBooleanHistoryValue (PropertyAtomBoolean propertyAtomBoolean, int idx)
Gets the value of given PropertyAtomBoolean, at specified index in the ring buffer. Oldest value at index 0.
getConceptReferenceConcept getConceptReference (PropertyAtomConceptReference parc, long time)
Gets the value of the PropertyAtomConceptReference at a particular time.
getConceptReferenceHistoryValueConcept getConceptReferenceHistoryValue (PropertyAtomConceptReference parc, int idx)
Gets the value of given PropertyAtomConceptReference, at specified index in the ring buffer. Oldest value at index 0.
getContainedConceptConcept getContainedConcept (PropertyAtomContainedConcept pacc, long time)
Gets the value of the PropertyAtomContainedConcept at a particular time.
getContainedConceptHistoryValueConcept getContainedConceptHistoryValue (PropertyAtomContainedConcept pacc, int idx)
Gets the value of given PropertyAtomContainedConcept, at specified index in the ring buffer. Oldest value at index 0.
getDateTimeDateTime getDateTime (PropertyAtomDateTime propertyAtomDateTime, long time)
Gets the value of the PropertyAtomDateTime at a particular time.
getDateTimeHistoryValueDateTime getDateTimeHistoryValue (PropertyAtomDateTime propertyAtomDateTime, int idx)
Gets the value of given PropertyAtomDateTime, at specified index in the ring buffer in the ring buffer. Oldest value at index 0.
getDoubledouble getDouble (PropertyAtomDouble propertyAtomDouble, long time)
Gets the value of the PropertyAtomDouble at a particular time.
getDoubleHistoryValuedouble getDoubleHistoryValue (PropertyAtomDouble propertyAtomDouble, int idx)
Gets the value of given PropertyAtomDouble, at specified index in the ring buffer. Oldest value at index 0.
getHistoryTimelong getHistoryTime(PropertyAtom propertyAtom, int idx)
Get the history timestamp of this PropertyAtom value for a given index. Returns 0 if the index has not yet been used.
getHistoryValueObject getHistoryValue(PropertyAtom propertyAtom, int idx)
Gets the value of given PropertyAtom, at specified index in the ring buffer. Oldest value at index 0.
getIntint getInt (PropertyAtomInt propertyAtomInt, long time)
Gets the value of the PropertyAtomInt at a particular time.
getIntHistoryValueint getIntHistoryValue (PropertyAtomInt propertyAtomInt, int idx)
Gets the value of given PropertyAtomInt, at specified index in the ring buffer. Oldest value at index 0.
getLonglong getLong (PropertyAtomLong propertyAtomLong, long time)
Gets the value of the PropertyAtomLong at a particular time.
getLongHistoryValuelong getLongHistoryValue (PropertyAtomLong propertyAtomLong, int idx)
Gets the value of given PropertyAtomLong, at specified index in the ring buffer. Oldest value at index 0.
getPropertyValueObject getPropertyValue(PropertyAtom propertyAtom)
Gets the value of a PropertyAtom.
getStringString getString (PropertyAtomString propertyAtomString, long time)
Gets the value of the PropertyAtomString at a particular time.
getStringHistoryValueString getStringHistoryValue (PropertyAtomString propertyAtomString, int idx)
Gets the value of given PropertyAtomString, at specified index in the ring buffer. Oldest value at index 0.
getValueAtObject getValueAt(PropertyAtom propertyAtom, long time)
Gets the value of the PropertyAtom at a particular time.
historySizeint historySize(PropertyAtom pa)
This method returns the size of the history buffer as specified in the design environment.
numHistoryValuesint numHistoryValues(PropertyAtom pa)
This method returns how many history values exist for given property.
setBooleanboolean setBoolean (PropertyAtomBoolean pab, boolean value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setConceptReferenceboolean setConceptReference (PropertyAtomConceptReference parc, Concept value, long time)
Sets the value of the PropertyAtomConceptReference to the value passed with the time stamp specified.
setContainedConceptboolean setContainedConcept (PropertyAtomContainedConcept pacc, ContainedConcept value, long time)
Sets the value of the PropertyAtomContainedConcept to the value passed with the time stamp specified.
setDateTimeboolean setDateTime (PropertyAtomDateTime padt, DateTime value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setDoubleboolean setDouble (PropertyAtomDouble pad, double value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setIntboolean setInt (PropertyAtomInt pai, int value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setLongboolean setLong (PropertyAtomLong pal, long value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setPropertyValueboolean setPropertyValue (PropertyAtom pa, Object value)
Sets the value of the PropertyAtom to the value passed.
setStringboolean setString (PropertyAtomString pas, String value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.
setValueAtboolean setValueAt (PropertyAtom pa, Object value, long time)
Sets the value of the PropertyAtom to the value passed with the time stamp specified.