VR-Link API Documentation for HLA 1516
Public Member Functions | Protected Member Functions | Protected Attributes
rti1516::CompatibleHandleValuePairSet< HandleType, MapType > Class Template Reference

Used to provide backwards compatibility for VR-Link Encoders and Decoders who use either AttributeHandleValuePairSet, or ParameterHandleValuePairSet. More...

+ Collaboration diagram for rti1516::CompatibleHandleValuePairSet< HandleType, MapType >:

List of all members.

Public Member Functions

 CompatibleHandleValuePairSet (MapType *AHVM)
 CompatibleHandleValuePairSet (const MapType *AHVM)
 ~CompatibleHandleValuePairSet ()
unsigned long size () const
HandleType getHandle (unsigned long i) const
unsigned long getValueLength (unsigned long i) const
void getValue (unsigned long i, char *buffer, unsigned long &valueLength) const
char * getValuePointer (unsigned long i, unsigned long &valueLength) const
void add (HandleType h, const char *buffer, unsigned long valueLength)
void remove (HandleType h)
void empty ()

Protected Member Functions

void updateCachedIterator (unsigned long i) const

Protected Attributes

MapType * myMap
int myLastPlace
MapType::iterator myLastMapPosition

Detailed Description

template<typename HandleType, typename MapType>
class rti1516::CompatibleHandleValuePairSet< HandleType, MapType >

Used to provide backwards compatibility for VR-Link Encoders and Decoders who use either AttributeHandleValuePairSet, or ParameterHandleValuePairSet.

In 1516 these both use std::map(s). This class provides a wrapper around a std::map.

It is not a full implementation of AttributeHandleValue set. It is just for backwards compatibility.

MapType is parameterized to handle Attribute Maps and Parameter Maps, which are the exact same thing except strongly typed


Constructor & Destructor Documentation

template<typename HandleType , typename MapType >
rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::CompatibleHandleValuePairSet ( MapType *  AHVM)
template<typename HandleType , typename MapType >
rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::CompatibleHandleValuePairSet ( const MapType *  AHVM)
template<typename HandleType , typename MapType >
rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::~CompatibleHandleValuePairSet ( )

Member Function Documentation

template<typename HandleType , typename MapType >
void rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::add ( HandleType  h,
const char *  buffer,
unsigned long  valueLength 
) [inline]
template<typename HandleType , typename MapType >
void rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::empty ( ) [inline]
template<typename HandleType , typename MapType >
HandleType rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::getHandle ( unsigned long  i) const [inline]
template<typename HandleType , typename MapType >
void rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::getValue ( unsigned long  i,
char *  buffer,
unsigned long &  valueLength 
) const [inline]
template<typename HandleType , typename MapType >
unsigned long rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::getValueLength ( unsigned long  i) const [inline]
template<typename HandleType , typename MapType >
char* rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::getValuePointer ( unsigned long  i,
unsigned long &  valueLength 
) const [inline]
template<typename HandleType , typename MapType >
void rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::remove ( HandleType  h) [inline]
template<typename HandleType , typename MapType >
unsigned long rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::size ( ) const [inline]
template<typename HandleType , typename MapType >
void rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::updateCachedIterator ( unsigned long  i) const [protected]

Member Data Documentation

template<typename HandleType , typename MapType >
MapType::iterator rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::myLastMapPosition [mutable, protected]
template<typename HandleType , typename MapType >
int rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::myLastPlace [mutable, protected]
template<typename HandleType , typename MapType >
MapType* rti1516::CompatibleHandleValuePairSet< HandleType, MapType >::myMap [protected]

The documentation for this class was generated from the following file:

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)