RIDXTarget Class Reference

#include <IRIDX.h>

Public Types
enum	Type { kUIDAsReference = 0, kUIDAsObject = 1 }

Public Member Functions
	RIDXTarget ()
	RIDXTarget (Type targetType, uint32 targetValue)
	RIDXTarget (uint32 targetType, uint32 targetValue)
RIDXTarget::Type	GetType () const
uint32	GetValue () const

Detailed Description

Represents the target part of a reference tracked by the reference index. It is a (type,value) pair representing some particular type of thing refered to in some particular source. Comparison operators ==, !=, and < are defined, and the rest are omitted by design. Ordering for operator < is the lexicographical ordering of the sequence targetType, targetValue.

See Also

RIDXSource

RIDXReference

IRIDX

Member Enumeration Documentation

enum RIDXTarget::Type

Type of target. Gives meaning and type to the value member of the RIDXTarget.

Enumerator
kUIDAsReference	The value is a UID that was referenced in the source's ReadWrite() by stream->XferReference(value);
kUIDAsObject	The value is a UID that was referenced in the source's ReadWrite() by stream->XferObject(value);

Constructor & Destructor Documentation

RIDXTarget::RIDXTarget ( )

inline

Constructs an uninitialized target.

RIDXTarget::RIDXTarget ( Type  targetType, uint32  targetValue  )

inline

Constructs a target.

Parameters

targetType	is the type of the target.
targetValue	is the target value, and the interpretation depends upon targetType.

RIDXTarget::RIDXTarget ( uint32  targetType, uint32  targetValue  )

inline

Constructs a target.

Parameters

targetType	is the type of the target.
targetValue	is the target value, and the interpretation depends upon the target's type.

Member Function Documentation

RIDXTarget::Type RIDXTarget::GetType ( void  ) const

inline

Gets the type of the target.

Returns

the type of the target.

uint32 RIDXTarget::GetValue ( ) const

inline

Gets the value of the target.

Returns

the value of the target. The interpretation depends upon the target's type.