pRTI™ v1.3

hla.rti
Interface ReflectedAttributes


public interface ReflectedAttributes

This packages the attributes supplied to the federate for reflectAttributeValues. This is conceptually an array with an initial capacity and the ability to grow. You enumerate by stepping index from 0 to size()-1.


Method Summary
 int getAttributeHandle(int index)
          Return attribute handle at index position.
 int getOrderType(int index)
          Return order handle at index position.
 Region getRegion(int index)
          Return Region handle at index position.
 int getTransportType(int index)
          Return transport handle at index position.
 byte[] getValue(int index)
          Return copy of value at index position.
 int getValueLength(int index)
          Return length of value at index position.
 byte[] getValueReference(int index)
          Get the reference of the value at position index (not a clone)
 int size()
           
 

Method Detail

getAttributeHandle

public int getAttributeHandle(int index)
                       throws hla.rti.ArrayIndexOutOfBounds
Return attribute handle at index position.
Parameters:
index - int
Returns:
int attribute handle
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getOrderType

public int getOrderType(int index)
                 throws hla.rti.ArrayIndexOutOfBounds
Return order handle at index position.
Parameters:
index - int
Returns:
int order type
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getRegion

public Region getRegion(int index)
                 throws hla.rti.ArrayIndexOutOfBounds
Return Region handle at index position.
Parameters:
index - int
Returns:
int region handle
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getTransportType

public int getTransportType(int index)
                     throws hla.rti.ArrayIndexOutOfBounds
Return transport handle at index position.
Parameters:
index - int
Returns:
int transport type
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getValue

public byte[] getValue(int index)
                throws hla.rti.ArrayIndexOutOfBounds
Return copy of value at index position.
Parameters:
index - int
Returns:
byte[] copy (clone) of value
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getValueLength

public int getValueLength(int index)
                   throws hla.rti.ArrayIndexOutOfBounds
Return length of value at index position.
Parameters:
index - int
Returns:
int value length
Throws:
hla.rti.ArrayIndexOutOfBounds -  

getValueReference

public byte[] getValueReference(int index)
                         throws hla.rti.ArrayIndexOutOfBounds
Get the reference of the value at position index (not a clone)
Parameters:
index - int
Returns:
byte[] the reference
Throws:
hla.rti.ArrayIndexOutOfBounds -  

size

public int size()
Returns:
int Number of attribute handle-value pairs

pRTI™ v1.3

Visit the pRTI™ Website

pRTI is a trademark of Pitch Technologies AB

Repslagaregatan 25
S-582 22 Linkoping,
Sweden.
All Rights Reserved.