Package sk.ipesoft.d2000.d2japi
Interface ArchiveObjectDescription
-
public interface ArchiveObjectDescription
Description of archive object.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getArchivedObjectColumnIndex()
Get one-based column index of cell in case of archived structured value or zero.int
getArchivedObjectHobj()
Get HOBJ of archived object.int
getArchivedObjectRowIndex()
Get one-based row index of cell in case of archived structured value or zero.ArchiveObjectType
getArchiveObjectType()
Get type of archive object.int
getColumnIndex()
Get one-based column index of cell from archived structured value or zero for non-structured value.java.lang.String
getDescription()
Get human readable (translatable) description of archive object.int
getHobj()
Get HOBJ of archive object.java.lang.String
getName()
Get name of the object in DODM.int
getPeriodSeconds()
Get length of archive object period in seconds or zero for non-periodic archive object.int
getRowIndex()
Get one-based row index of cell from archived structured value or zero for non-structured value.int
getStateTextHobj()
Get HOBJ of associated state text object.java.lang.String
getTechnicalUnits()
Get human readable (translatable) description of techical units.int
getTransformationPaletteIndex()
Get one-based index of associated transformation palette.sk.ipesoft.d2000.base.UnivalValueType
getUnivalValueType()
Get type of values stored in archive object.boolean
isEditable()
Gettrue
if object is editable orfalse
if it is not.boolean
isPeriodic()
Gettrue
if values are archived periodically orfalse
if they are archived on change of archived object value.boolean
isWritingToStartOfTheInterval()
Gettrue
if periodic statistical archive writes computed value at the start of processed time interval orfalse
when it writes to the end of the interval.
-
-
-
Method Detail
-
getArchiveObjectType
ArchiveObjectType getArchiveObjectType()
Get type of archive object.- Returns:
- type of archive object
-
getArchivedObjectColumnIndex
int getArchivedObjectColumnIndex()
Get one-based column index of cell in case of archived structured value or zero.- Returns:
- one-based column index or zero
-
getArchivedObjectHobj
int getArchivedObjectHobj()
Get HOBJ of archived object.- Returns:
- HOBJ
-
getArchivedObjectRowIndex
int getArchivedObjectRowIndex()
Get one-based row index of cell in case of archived structured value or zero.- Returns:
- one-based row index or zero
-
getColumnIndex
int getColumnIndex()
Get one-based column index of cell from archived structured value or zero for non-structured value.- Returns:
- one-based column index of cell from archived structured value or zero
-
getDescription
java.lang.String getDescription()
Get human readable (translatable) description of archive object.- Returns:
- human readable description of object
-
getHobj
int getHobj()
Get HOBJ of archive object.- Returns:
- HOBJ
-
getName
java.lang.String getName()
Get name of the object in DODM.- Returns:
- name of the object
-
getPeriodSeconds
int getPeriodSeconds()
Get length of archive object period in seconds or zero for non-periodic archive object.- Returns:
- length of period in seconds
-
getRowIndex
int getRowIndex()
Get one-based row index of cell from archived structured value or zero for non-structured value.- Returns:
- one-based row index of cell from archived structured value or zero
-
getStateTextHobj
int getStateTextHobj()
Get HOBJ of associated state text object.- Returns:
- HOBJ
-
getTechnicalUnits
java.lang.String getTechnicalUnits()
Get human readable (translatable) description of techical units.- Returns:
- human readable technical units
-
getTransformationPaletteIndex
int getTransformationPaletteIndex()
Get one-based index of associated transformation palette.- Returns:
- one-based index
-
getUnivalValueType
sk.ipesoft.d2000.base.UnivalValueType getUnivalValueType()
Get type of values stored in archive object.- Returns:
- type of value
-
isEditable
boolean isEditable()
Gettrue
if object is editable orfalse
if it is not.- Returns:
true
for editable archive object;false
otherwise
-
isPeriodic
boolean isPeriodic()
Gettrue
if values are archived periodically orfalse
if they are archived on change of archived object value.- Returns:
true
for periodic archive object;false
otherwise
-
isWritingToStartOfTheInterval
boolean isWritingToStartOfTheInterval()
Gettrue
if periodic statistical archive writes computed value at the start of processed time interval orfalse
when it writes to the end of the interval.- Returns:
true
if value is written to the start of processed interval;false
otherwise
-
-