TuttleOFX  1
Public Member Functions | Protected Attributes
OFX::Validation::PropertySetDescription Class Reference

Describes a set of properties. More...

#include <ofxsSupportPrivate.h>

Public Member Functions

 PropertySetDescription (const char *setName,...)
 constructor.
virtual ~PropertySetDescription ()
 destructor
void addProperty (PropertyDescription *desc, bool deleteOnDestruction=true)
 add another property in
void validate (OFX::PropertySet &propSet, bool checkDefaults=true, bool logOrdinaryMessages=false)
 See if all properties exist and have the correct dimensions.

Protected Attributes

std::string _setName
 name of the property set
std::vector
< PropertyDescription * > 		_descriptions
 the descriptions of each property
std::vector
< PropertyDescription * > 		_deleteThese
 The descriptions of each property.

Detailed Description

Describes a set of properties.

Definition at line 189 of file ofxsSupportPrivate.h.

Constructor & Destructor Documentation

OFX::Validation::PropertySetDescription::PropertySetDescription ( const char *  setName,
  ... 
)

constructor.

A set of property descriptions, constructor.

The varargs zero terminated are made from pairs of PropertyDescription * and ints indicating the number of properties pointed to. These are to come from static arrays and need not be deleted

Passed in as a zero terminated pairs of (PropertyDescription *descArray, int nDescriptions)

Definition at line 242 of file ofxsPropertyValidation.cpp.

References _descriptions.

OFX::Validation::PropertySetDescription::~PropertySetDescription ( ) [virtual]

destructor

Definition at line 276 of file ofxsPropertyValidation.cpp.

References _deleteThese.

Member Function Documentation

void OFX::Validation::PropertySetDescription::addProperty ( PropertyDescription *  desc,
bool  deleteOnDestruction = true 
)

add another property in

Add more properties into the property vector.

Definition at line 287 of file ofxsPropertyValidation.cpp.

References _deleteThese, and _descriptions.

Referenced by OFX::Validation::initialise().

void OFX::Validation::PropertySetDescription::validate ( OFX::PropertySet &  propSet,
bool  checkDefaults = true,
bool  logOrdinaryMessages = false 
)

See if all properties exist and have the correct dimensions.

Validate all the properties in the set.

Definition at line 296 of file ofxsPropertyValidation.cpp.

References _descriptions, _setName, OFX::Log::indent(), OFX::Log::outdent(), OFX::Log::print(), OFX::PropertySet::propDisableLogging(), and OFX::PropertySet::propEnableLogging().

Referenced by OFX::Validation::validateActionArgumentsProperties(), OFX::Validation::validateClipDescriptorProperties(), OFX::Validation::validateClipInstanceProperties(), OFX::Validation::validateHostProperties(), OFX::Validation::validateImageProperties(), OFX::Validation::validateParameterProperties(), OFX::Validation::validatePluginDescriptorProperties(), and OFX::Validation::validatePluginInstanceProperties().

Here is the call graph for this function:

Field Documentation

std::vector<PropertyDescription*> OFX::Validation::PropertySetDescription::_deleteThese [protected]

The descriptions of each property.

Definition at line 199 of file ofxsSupportPrivate.h.

Referenced by addProperty(), and ~PropertySetDescription().

std::vector<PropertyDescription*> OFX::Validation::PropertySetDescription::_descriptions [protected]

the descriptions of each property

Definition at line 196 of file ofxsSupportPrivate.h.

Referenced by addProperty(), PropertySetDescription(), and validate().

std::string OFX::Validation::PropertySetDescription::_setName [protected]

name of the property set

Definition at line 193 of file ofxsSupportPrivate.h.

Referenced by validate().

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