OFX::PropertySet Class Reference

#include <ofxsCore.h>

List of all members.

---

Detailed Description

This class wraps up an OFX property set.

Public Member Functions
	PropertySet (OfxPropertySetHandle h=0)
	construct a property set
virtual	~PropertySet ()
	Virtual destructor.
void	propSetHandle (OfxPropertySetHandle h)
	set the handle to use for this set
OfxPropertySetHandle	propSetHandle (void)
	return the handle for this property set
int	propGetDimension (const char *property, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, returns the dimension of the given property from this property set
void	propReset (const char *property) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, resets the property to it's default value
void	propSetPointer (const char *property, void *value, int idx, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, Set a single dimension pointer property
void	propSetString (const char *property, const std::string &value, int idx, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, Set a single dimension string property
void	propSetDouble (const char *property, double value, int idx, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, Set a single dimension double property
void	propSetInt (const char *property, int value, int idx, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	, Set a single dimension int property
void	propSetPointer (const char *property, void *value, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
void	propSetString (const char *property, const std::string &value, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
void	propSetDouble (const char *property, double value, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
void	propSetInt (const char *property, int value, bool throwOnFailure=true) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
void *	propGetPointer (const char *property, int idx, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	Get single pointer property.
std::string	propGetString (const char *property, int idx, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	Get single string property.
double	propGetDouble (const char *property, int idx, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	Get single double property.
int	propGetInt (const char *property, int idx, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	Get single int property.
void *	propGetPointer (const char *property, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	get a string property with index 0
std::string	propGetString (const char *property, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	get a string property with index 0
double	propGetDouble (const char *property, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	get a double property with index 0
int	propGetInt (const char *property, bool throwOnFailure=true) const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
	get an int property with index 0
Static Public Member Functions
void	propEnableLogging (void)
	turns on logging of property access functions
void	propDisableLogging (void)
	turns off logging of property access functions
void	setThrowOnUnsupportedProperties (bool v)
	Do we throw an exception if a host returns 'unsupported' when setting a property. Default is true.
bool	getThrowOnUnsupportedProperties (void)
	Do we throw an exception if a host returns 'unsupported' when setting a property. Default is true.
Protected Attributes
OfxPropertySetHandle	_propHandle
	The raw property handle.
Static Protected Attributes
int	_gPropLogging = 1
	are we logging property get/set
bool	_gThrowOnUnsupported = true
	Do we throw an exception if a host returns 'unsupported' when setting a property.

---

Constructor & Destructor Documentation

OFX::PropertySet::PropertySet (  OfxPropertySetHandle  h = 0  )  [inline]

construct a property set

OFX::PropertySet::~PropertySet (   )  [virtual]

Virtual destructor.

---

Member Function Documentation

bool OFX::PropertySet::getThrowOnUnsupportedProperties (  void   )  [inline, static]

Do we throw an exception if a host returns 'unsupported' when setting a property. Default is true.

void OFX::PropertySet::propDisableLogging (  void   )  [inline, static]

turns off logging of property access functions

void OFX::PropertySet::propEnableLogging (  void   )  [inline, static]

turns on logging of property access functions

int OFX::PropertySet::propGetDimension (  const char *  property, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, returns the dimension of the given property from this property set

double OFX::PropertySet::propGetDouble (  const char *  property, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

get a double property with index 0

double OFX::PropertySet::propGetDouble (  const char *  property, int  idx, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

Get single double property.

int OFX::PropertySet::propGetInt (  const char *  property, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

get an int property with index 0

int OFX::PropertySet::propGetInt (  const char *  property, int  idx, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

Get single int property.

void* OFX::PropertySet::propGetPointer (  const char *  property, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

get a string property with index 0

void * OFX::PropertySet::propGetPointer (  const char *  property, int  idx, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

Get single pointer property.

std::string OFX::PropertySet::propGetString (  const char *  property, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

get a string property with index 0

std::string OFX::PropertySet::propGetString (  const char *  property, int  idx, bool  throwOnFailure = true )  const throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

Get single string property.

void OFX::PropertySet::propReset (  const char *  property  )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, resets the property to it's default value

void OFX::PropertySet::propSetDouble (  const char *  property, double  value, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

void OFX::PropertySet::propSetDouble (  const char *  property, double  value, int  idx, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, Set a single dimension double property

OfxPropertySetHandle OFX::PropertySet::propSetHandle (  void   )  [inline]

return the handle for this property set

void OFX::PropertySet::propSetHandle (  OfxPropertySetHandle  h  )  [inline]

set the handle to use for this set

void OFX::PropertySet::propSetInt (  const char *  property, int  value, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

void OFX::PropertySet::propSetInt (  const char *  property, int  value, int  idx, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, Set a single dimension int property

void OFX::PropertySet::propSetPointer (  const char *  property, void *  value, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

void OFX::PropertySet::propSetPointer (  const char *  property, void *  value, int  idx, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, Set a single dimension pointer property

void OFX::PropertySet::propSetString (  const char *  property, const std::string &  value, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite) [inline]

void OFX::PropertySet::propSetString (  const char *  property, const std::string &  value, int  idx, bool  throwOnFailure = true )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

, Set a single dimension string property

void OFX::PropertySet::setThrowOnUnsupportedProperties (  bool  v  )  [inline, static]

Do we throw an exception if a host returns 'unsupported' when setting a property. Default is true.

---

Member Data Documentation

int OFX::PropertySet::_gPropLogging = 1 [static, protected]

are we logging property get/set

bool OFX::PropertySet::_gThrowOnUnsupported = true [static, protected]

Do we throw an exception if a host returns 'unsupported' when setting a property.

OfxPropertySetHandle OFX::PropertySet::_propHandle [protected]

The raw property handle.

---

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

• ofxsCore.h
• ofxsProperty.cpp

---