OpenGL Vizserver Reference Page

NAME

vsCmprParamTypeCls - Compressor parameter type information interface

INHERITS FROM

vsParamTypeCls

HEADER FILE

#include <vizserver/vsQueryType.h>

PUBLIC METHOD SUMMARY

virtual ParamGroup getParamName (

) const;

virtual ~vsCmprParamTypeCls (

);

INHERITED PUBLIC METHODS

   Inherited from vsParamTypeCls

virtual vsBool isParamTypeSupported (

vsParamTypes::Base name) const;

CLASS DESCRIPTION

Parameters passed through the Vizserver Compression API are all derived from this class. This class interface provides a layer for identifying the parameter's type name from the parameter's type family enum.

This class is a template with ParamGroup being the template argument. The valid ParamGroup types are the following:

vsCmprParamTypes::AllParams is the most generic compressor parameter type.

vsCmprParamTypes::FieldParams are the parameters that relate only to field specific information. vsFieldInfo and vsFieldData are of this parameter group.

vsCmprParamTypes::QueryParams identifies parameters that are also query type containers with embedded parameters. These parameter types support vsQueryTypeNameAccessorCls interface and therefore can be casted to this type. vsFrameInfo and vsFrameData belong to this parameter group.

vsCmprParamTypes::QueryMessages identifies parameters that are query type containers for API messaging. These parameters support vsQueryTypeNameAccessorCls as well as additional messaging interfaces. vsStreamMessage is the only message type of this parameter group.

Calling getParamName() returns the parameter name for the associated ParamGroup. The parameter name identifies the class of the parameter type. For instance if getParamName() returns vsCmprParamTypes::FrameInfo, the parameter object is of the vsFrameInfo class. This is useful for upcasting a vsParamTypeCls pointer to a concrete parameter type.

METHOD DESCRIPTIONS

   ~vsCmprParamTypeCls()

virtual ~vsCmprParamTypeCls (

);

Object destructor

   getParamName()

virtual ParamGroup getParamName (

) const;

Returns the parameter name for this parameter type. The return type will be of the associated parameter group.

SEE ALSO

vsFieldData, vsFieldInfo, vsFrameData, vsFrameInfo, vsParamTypeCls, vsQueryTypeNameAccessorCls, vsStreamMessage

---