ofxsPropertyValidation.cpp File Reference

---

Detailed Description

This file contains headers for classes that are used to validate property sets and make sure they have the right members and default values.

#include "ofxsSupportPrivate.h"
#include <stdarg.h>

Namespaces
namespace	OFX
namespace	OFX::Validation
Defines
#define	NULLPTR   ((void *)(0))
	Null pointer definition.
#define	kOfxsDisableValidation
#define	kOfxsDisableValidation
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

---

Define Documentation

#define kOfxsDisableValidation

#define kOfxsDisableValidation

#define NULLPTR   ((void *)(0))

Null pointer definition.

---

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.

---