OFX::Validation Namespace Reference

---

Detailed Description

The validation code has its own namespace.

Classes
struct	OFX::Validation::ValueHolder
	This is uses to hold a property value, used by the property checking classes. More...
class	OFX::Validation::PropertyDescription
	class to describe properties, check their default and set their values More...
class	OFX::Validation::PropertySetDescription
	Describes a set of properties. More...
Enumerations
enum	DescriptionTag { eDescDefault, eDescFinished }
	Enum used in the varargs list of the PropertyDescription constructor. More...
Functions
void	validateHostProperties (OfxHost *host)
	Validates the host structure and property handle.
void	validatePluginDescriptorProperties (PropertySet props)
	Validates the effect descriptor properties.
void	validatePluginInstanceProperties (PropertySet props)
	Validates the effect instance properties.
void	validateClipDescriptorProperties (PropertySet props)
	validates a clip descriptor
void	validateClipInstanceProperties (PropertySet props)
	validates a clip instance
void	validateImageProperties (PropertySet props)
	validates a clip descriptor
void	validateActionArgumentsProperties (const std::string &action, PropertySet inArgs, PropertySet outArgs)
	Validates action in/out arguments.
void	validateParameterProperties (ParamTypeEnum paramType, OFX::PropertySet paramProps, bool checkDefaults)
	Validates parameter properties.
void	initialise (void)
	initialises the validation code, call this in on load

---

Enumeration Type Documentation

enum DescriptionTag

Enum used in the varargs list of the PropertyDescription constructor. Enumeration values: eDescDefault  eDescFinished  following values are the default to check against we have finished the description

---

Function Documentation

void OFX::Validation::initialise (  void   )

initialises the validation code, call this in on load

void OFX::Validation::validateActionArgumentsProperties (  const std::string &  action, PropertySet  inArgs, PropertySet  outArgs )

Validates action in/out arguments.

void OFX::Validation::validateClipDescriptorProperties (  PropertySet  props  )

validates a clip descriptor

void OFX::Validation::validateClipInstanceProperties (  PropertySet  props  )

validates a clip instance

void OFX::Validation::validateHostProperties (  OfxHost *  host  )

Validates the host structure and property handle.

void OFX::Validation::validateImageProperties (  PropertySet  props  )

validates a clip descriptor

void OFX::Validation::validateParameterProperties (  ParamTypeEnum  paramType, OFX::PropertySet  paramProps, bool  checkDefaults )

Validates parameter properties.

void OFX::Validation::validatePluginDescriptorProperties (  PropertySet  props  )

Validates the effect descriptor properties.

void OFX::Validation::validatePluginInstanceProperties (  PropertySet  props  )

Validates the effect instance properties.

---