The HyperPoint object contains the following properties.
The Value, Timestamp, Status, and UserStatus properties are read from/written to the HyperPoint Scripting Service. The remaining properties are read from/written to the Point Service. Properties are referred to in the following format: object.property (where object is a HyperPoint object).
| Property | SubType | Read Only | Description |
|---|---|---|---|
|
AlarmPriorityCategory |
Long |
Yes |
Returns the Alarm Priority Category from the Point Service record. |
|
AlternateUnits |
String |
Yes |
Returns the Alternate Units from the Point Service record. |
|
AlternateValue |
String |
Yes |
Returns the Alternate Value string from the Point Service record. |
|
Comments |
String |
Yes |
Returns data from the "Comments" field in the Point Service record. |
|
Description |
String |
Yes |
Returns data from the "Description" field in the Point Service record. |
|
Facility |
String |
Yes |
Returns data from the "Facility" field in the Point Service record. Facility is maximum 20 characters. |
|
FullTag |
String |
Yes |
Returns the "Full Tag" string from the Point Service record. Full Tag format is Site.Service.PointID:LongID. |
|
LongDescription |
String |
Yes |
Returns the "Long Description" string from the Point Service record. |
|
LongPointID |
String |
Yes |
Returns the "Long Point ID" from the Point Service record. Long Point ID is maximum 31 characters. |
|
LongTag |
String |
Yes |
Returns the "Long Tag" string from the Point Service record. Long Tag format is Site.Service:LongID. |
|
Name |
String |
Yes |
Returns data from the "Name" field in the Point Service record. |
|
PointID |
String |
Yes |
Returns the "Point ID" from the Point Service record. Point ID is maximum 8 characters. |
|
PointScheme |
Long |
Yes |
Returns an integer representing the Point Scheme. |
|
PrimaryUnits |
String |
Yes |
Returns the Primary Units from the Point Service record. |
|
PrimaryValue |
String |
Yes |
Returns the Primary Value string from the Point Service record. |
|
Service |
String |
Yes |
Returns the "Service" from the Point Service record. Service is maximum 8 characters and is the tag’s current value service. |
|
ShortDescription |
String |
Yes |
Returns the "Short Description" string from the Point Service. |
|
Site |
String |
Yes |
Returns the "Site" from the Point Service record. Site is maximum 8 characters. |
|
SiteService |
String |
Yes |
Returns the "Site" and "Service" from the Point Service record. Format is Site.Service. Both Site and Service are maximum 8 characters. Service is the current value service of the tag. |
|
Status |
Integer |
No |
Returns/sets the "Status" word of the object in the HSS. Only bits 2-8 and 11 may be modified. When changing the value of the status word, "OR" the present value of the word with the bit mask of the values you wish to set/clear. This preserves the value of the status word that you are not changing. |
|
System |
String |
Yes |
Returns data from the "System" field in the Point Service record. "System"is a user-defined field. Entries are stored in the Table Reference Service. |
|
Tag |
String |
Yes |
Returns the "Full Tag" string from the Point Service record. Full Tag format is Site.Service.PointID:LongID. |
|
Timestamp |
Date/Time |
No |
Returns/sets the "Timestamp" of the object in the HSS. This property utilizes the VB date/time format. |
|
UDC |
String |
Yes |
Returns data from the "Uniform Data Code" field in the Point Service record. UDC is maximum 10 characters. |
|
Units |
String |
Yes |
Returns data from the "Units" field in the Point Service record. |
|
UserStatus |
Long |
No |
Returns/sets the "User Status" bits of the object in the HSS. The User Status bits are rarely used. They can be used to temporarily store information or as a flag. |
|
Value |
String |
No |
Returns/sets the "Value" of the object in the HSS. |
|
|
|
