open-dis-cpp
Static Public Member Functions | Static Public Attributes | List of all members
DIS::Convert Struct Reference

a name-scope for conversion functions. More...

#include <Conversion.h>

Static Public Member Functions

static int MakeArticulationParameterType (int typeclass, int typemetric)
 make the value needed for the ArticulationParameter's Parameter Type. More...
 
static int GetArticulationTypeMetric (int parametertype)
 extract the data for the type metric value stored within the parameter type value. More...
 
static int GetArticulationTypeClass (int parametertype)
 extract the data for the type class value stored within the parameter type value. More...
 

Static Public Attributes

static const unsigned char ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS = 5
 the number of bits used to store the type metric value within the Articulation Parameter's parameter type value. More...
 

Detailed Description

a name-scope for conversion functions.

Member Function Documentation

◆ GetArticulationTypeClass()

int Convert::GetArticulationTypeClass ( int  parametertype)
static

extract the data for the type class value stored within the parameter type value.

this an inverse to the function, MakeArticulationParameterType.

Parameters
parametertypethe value storing the type metric and type class values.
Returns
the type class value, with ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS bits precision

◆ GetArticulationTypeMetric()

int Convert::GetArticulationTypeMetric ( int  parametertype)
static

extract the data for the type metric value stored within the parameter type value.

this an inverse to the function, MakeArticulationParameterType.

Parameters
parametertypethe value storing the type metric and type class values.
Returns
the type metric value, with ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS bits precision.

◆ MakeArticulationParameterType()

int Convert::MakeArticulationParameterType ( int  typeclass,
int  typemetric 
)
static

make the value needed for the ArticulationParameter's Parameter Type.

Parameters
typeclassthe enumeration for the articulated part. This must have less precision than ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS.
typemetricthe enumeration for the motion description. this must have less precision than 32 - ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS.
Returns
the value to be used as the Parameter Type, with 32 bits precision.

Member Data Documentation

◆ ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS

const unsigned char DIS::Convert::ARTICULATION_PARAMETER_TYPE_METRIC_NUMBER_OF_BITS = 5
static

the number of bits used to store the type metric value within the Articulation Parameter's parameter type value.

this mask is based on the IEEE Std 1278.1-1995


The documentation for this struct was generated from the following files: