dtHLAGM::ParameterValue Class Reference

A DIS/RPR-FOM parameter value. More...

#include <distypes.h>

List of all members.

Public Member Functions
	ParameterValue (ArticulatedParameterType type=ArticulatedPart)
	Constructor.
	ParameterValue (const ArticulatedParts &articulatedParts)
	Constructor.
	ParameterValue (const AttachedParts &attachedParts)
	Constructor.
size_t	EncodedLength () const
	Returns the encoded length of this object.
void	Encode (char *buf) const
	Encodes this object into the specified buffer.
void	Decode (const char *buf)
	Decodes the values contained in the specified buffer.
void	SetArticulatedParameterType (ArticulatedParameterType type)
	Sets the articulated parameter type.
ArticulatedParameterType	GetArticulatedParameterType () const
	Returns the articulated parameter type.
void	SetArticulatedParts (const ArticulatedParts &articulatedParts)
	Sets the articulated parts structure.
ArticulatedParts &	GetArticulatedParts ()
	Returns the articulated parts structure.
const ArticulatedParts &	GetArticulatedParts () const
void	SetAttachedParts (const AttachedParts &attachedParts)
	Sets the attached parts structure.
AttachedParts &	GetAttachedParts ()
	Returns the attached parts structure.
const AttachedParts &	GetAttachedParts () const
bool	IsEqual (const ParameterValue &other) const
	Returns true if the parameter types and the relevant structures match.

---

Detailed Description

A DIS/RPR-FOM parameter value.

---

Constructor & Destructor Documentation

dtHLAGM::ParameterValue::ParameterValue

(

ArticulatedParameterType

type = ArticulatedPart

)

Constructor.

Parameters:

type

the articulated parameter type

dtHLAGM::ParameterValue::ParameterValue

(

const ArticulatedParts &

articulatedParts

)

Constructor.

Parameters:

articulatedParts

the articulated parts

dtHLAGM::ParameterValue::ParameterValue

(

const AttachedParts &

attachedParts

)

Constructor.

Parameters:

attachedParts

the attached parts

---

Member Function Documentation

size_t dtHLAGM::ParameterValue::EncodedLength

(

)

const

Returns the encoded length of this object.

Returns:

the encoded length of this object, in bytes

void dtHLAGM::ParameterValue::Encode

(

char *

buf

)

const

Encodes this object into the specified buffer.

Parameters:

buf

the buffer to contain the encoded object

void dtHLAGM::ParameterValue::Decode

(

const char *

buf

)

Decodes the values contained in the specified buffer.

Parameters:

buf

the buffer containing the encoded object

void dtHLAGM::ParameterValue::SetArticulatedParameterType

(

ArticulatedParameterType

type

)

Sets the articulated parameter type.

Parameters:

type

the articulated parameter type

ArticulatedParameterType dtHLAGM::ParameterValue::GetArticulatedParameterType

(

)

const

Returns the articulated parameter type.

Returns:

the articulated parameter type

void dtHLAGM::ParameterValue::SetArticulatedParts

(

const ArticulatedParts &

articulatedParts

)

Sets the articulated parts structure.

Parameters:

articulatedParts

the articulated parts structure to copy

ArticulatedParts & dtHLAGM::ParameterValue::GetArticulatedParts

(

)

Returns the articulated parts structure.

Returns:

the articulated parts structure

const ArticulatedParts & dtHLAGM::ParameterValue::GetArticulatedParts

(

)

const

void dtHLAGM::ParameterValue::SetAttachedParts

(

const AttachedParts &

attachedParts

)

Sets the attached parts structure.

Parameters:

attachedParts

the attached parts structure to copy

AttachedParts & dtHLAGM::ParameterValue::GetAttachedParts

(

)

Returns the attached parts structure.

Returns:

the attached parts structure

const AttachedParts & dtHLAGM::ParameterValue::GetAttachedParts

(

)

const

bool dtHLAGM::ParameterValue::IsEqual

(

const ParameterValue &

other

)

const

Returns true if the parameter types and the relevant structures match.

If parameter type is AttachedPart, comparisons will be performed only on the contained AttachedParts structures while ignoring the ArticulatedParts structures. If parameter type is ArticulatedPart, comparisons will be performed only on the contained ArticulatedParts structures while ignoring the AttachedParts structures.

Parameters:

other

The other ParameterValue to be compared

Returns:

true if the relevant values are equal between this and other

---