OFX::Validation::PropertyDescription Class Reference

class to describe properties, check their default and set their values More...

#include <ofxsSupportPrivate.h>

Public Member Functions
	PropertyDescription (const char *name, OFX::PropertyTypeEnum ilk, int dimension,...)
	var args constructor that is use to describe properties
virtual	~PropertyDescription (void)
	Die! Die! Die!
void	validate (bool checkDefaults, PropertySet &propSet)
	See if the property exists in the containing property set and has the correct dimension.
Data Fields
std::string	_name
	name of the property
bool	_exists
	Was it validated.
int	_dimension
	dimension of the property
OFX::PropertyTypeEnum	_ilk
	What type of property is it.
std::vector< ValueHolder >	_defaultValue
	The default value that this property should have. Empty implies no default (eg: a host name has no default).

---

Detailed Description

class to describe properties, check their default and set their values

Definition at line 159 of file ofxsSupportPrivate.h.

---

Constructor & Destructor Documentation

OFX::Validation::PropertyDescription::PropertyDescription	(	const char *	name,
		OFX::PropertyTypeEnum	ilk,
		int	dimension,
			...
	)

var args constructor that is use to describe properties

PropertyDescription var-args constructor.

Definition at line 105 of file ofxsPropertyValidation.cpp.

References _defaultValue, OFX::Validation::eDescDefault, OFX::Validation::eDescFinished, and OFX::Validation::setVectorFromVarArgs().

Here is the call graph for this function:

virtual OFX::Validation::PropertyDescription::~PropertyDescription

(

void

)

[inline, virtual]

Die! Die! Die!

Definition at line 182 of file ofxsSupportPrivate.h.

---

Member Function Documentation

void OFX::Validation::PropertyDescription::validate	(	bool	checkDefaults,
		PropertySet &	propSet
	)

See if the property exists in the containing property set and has the correct dimension.

Definition at line 139 of file ofxsPropertyValidation.cpp.

References _defaultValue, _dimension, _exists, _ilk, _name, OFX::eDouble, OFX::eInt, OFX::ePointer, OFX::Log::error(), OFX::eString, OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), and OFX::PropertySet::propGetString().

Here is the call graph for this function:

---

Field Documentation

std::vector<ValueHolder> OFX::Validation::PropertyDescription::_defaultValue

The default value that this property should have. Empty implies no default (eg: a host name has no default).

Definition at line 175 of file ofxsSupportPrivate.h.

Referenced by PropertyDescription(), and validate().

int OFX::Validation::PropertyDescription::_dimension

dimension of the property

Definition at line 169 of file ofxsSupportPrivate.h.

Referenced by validate().

bool OFX::Validation::PropertyDescription::_exists

Was it validated.

Definition at line 166 of file ofxsSupportPrivate.h.

Referenced by validate().

OFX::PropertyTypeEnum OFX::Validation::PropertyDescription::_ilk

What type of property is it.

Definition at line 172 of file ofxsSupportPrivate.h.

Referenced by validate().

std::string OFX::Validation::PropertyDescription::_name

name of the property

Definition at line 163 of file ofxsSupportPrivate.h.

Referenced by validate().

---

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

• libraries/openfxHack/Support/Library/ofxsSupportPrivate.h
• libraries/openfxHack/Support/Library/ofxsPropertyValidation.cpp