OpenGL Vizserver Reference Page


NAME
vsParamTypeCls - Base class for all compressor parameter types

HEADER FILE
#include <vizserver/vsQueryType.h>

PUBLIC METHOD SUMMARY
virtual vsBool isParamTypeSupported ( vsParamTypes::Base name) const = 0;
virtual ~vsParamTypeCls (  );

CLASS DESCRIPTION
All parameters passed through the Vizserver Compression API are derived from this class. It supports one function call, isParamTypeSupported() which provides information about the parameter's interface type. Currently there are only 3 supported parameter types:

vsParamTypes::CmprParam identifies the most basic parameter that contains no additional functionailty. vsFieldInfo, and vsFieldData are of this type family.

vsParamTypes::CmprQueryParam 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 type family.

vsParamTypes::CmprQueryMessage 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 type family.

By using this interface, a generic parameter can be classified and up-casted safely to different parameter and query type container interfaces. The functionality provided by vsCmprParamTypeCls aid the parameter identification process.

METHOD DESCRIPTIONS

   ~vsParamTypeCls()
virtual ~vsParamTypeCls (  );

Object destructor

   isParamTypeSupported()
virtual vsBool isParamTypeSupported ( vsParamTypes::Base name) const = 0;

Returns TRUE if the parameter is of the parameter family identified by name. The values for the parameter families is of type vsParamTypes::Base.

SEE ALSO
vsCmprParamTypeCls, vsFieldData, vsFieldInfo, vsFrameData, vsFrameInfo, vsQueryTypeNameAccessorCls, vsStreamMessage