ClockTime (DIS-Java-VRML Javadoc)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

mil.navy.nps.dis
Class ClockTime

java.lang.Object
  mil.navy.nps.dis.PduElement
      mil.navy.nps.dis.ClockTime

Special clock time reporting class.

Version:: 1.0
Author:: Antonio Alexandre Rua (http://www.garfield.fe.up.pt/~alexrua)
Location:: Web: http://www.web3d.org/WorkingGroups/vrtp/mil/navy/nps/dis/ClockTime.java; or locally: ~/mil/navy/nps/dis/ClockTime.java
Hierarchy Diagram:
Summary:: Time measurements that surpass one hour shall be represented by a Clock Time Record. The time represented shall be either real-world time (UTC) or simulation time. The simulation time shall be the UTC of the simulation exercise.
Note:: Here we don't implement the Timestamp record. Yet we don't have the same trouble using it as in ProtocolDataUnit. You should consult our on-line documentation to see the trouble using time.
History:: 16Sep97 /Antonio Alexandre Rua /New; 8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation; 11Dec97 /Ronan Fauglas /changed access methods: thisVariable() --> getThisVariable()
References:: DIS-Java-VRML Working Group: http://www.web3d.org/WorkingGroups/vrtp/dis-java-vrml/; DIS Data Dictionary :Clock Time Record; DIS specification : IEEE 1278.1, Section 5.3.8
See Also:: ProtocolDataUnit, PduElement, SerializationInterface, SimulationManagementFamily

Field Summary
`protected int`	`hour` Hours - This field shall specify the hours since 0000 hours January 1, 1970 UTC.
`static int`	`sizeOf` Constant value--size of a Clock Time Record; here :`sizeOf = 8 bytes`.
`protected UnsignedInt`	`timePastHour` Time Past the Hour - This field shall specify the time past the hour indicated in Hour field.

Constructor Summary
`ClockTime()` Default constructor--fills with zeros for all values.
`ClockTime(long pHour, long pTimePastHour)` Constructs a new ClockTime object whose values are passed in parameters.

Method Summary
`java.lang.Object`	`clone()` Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data.
`void`	`deSerialize(java.io.DataInputStream inputStream)` Deserialize our data from the input stream.
`int`	`getHour()`
`int`	`getTimePastHour()`
`int`	`length()` Returns the length of the object when serialized in a stream.
`void`	`printValues(int indentLevel, java.io.PrintStream printStream)` Prints the generated serialized object for debugging.
`void`	`serialize(java.io.DataOutputStream outputStream)` Serialize our data out to the stream.
`void`	`setHour(int pHour)`
`void`	`setHour(long pHour)`
`void`	`setTimePastHour(long pTimePastHour)`
`void`	`setTimePastHour(UnsignedInt pTimePastHour)`
`void`	`setValues(long pHour, long pTimePastHour)`

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

protected int hour

Hours - This field shall specify the hours since 0000 hours January 1, 1970 UTC.

protected UnsignedInt timePastHour

Time Past the Hour - This field shall specify the time past the hour indicated in Hour field.

Value:: This field is actually a Timestamp. See the references below for more information.
References:: DIS Data Dictionary :Hours field

public static final int sizeOf

Constant value--size of a Clock Time Record; here :sizeOf = 8 bytes.

Constructor Detail

public ClockTime()

Default constructor--fills with zeros for all values.

public ClockTime(long pHour,
                 long pTimePastHour)

Constructs a new ClockTime object whose values are passed in parameters.
Parameters:: pHour - the passed hours since 0000 hours January 1, 1970 UTC; pTimePastHour - the Timestamp of the new object

Method Detail