PBValidator Class Reference

This reference page is linked to from the following overview topics: Parameter Tags.

---

Search for all occurrences

---

Detailed Description

See also:

Structure ParamDef, List of Type 2 Params, Class ParamBlockDesc2.

Description:

A pointer to an instance of this class is a data member of struct ParamDef and is also used by the p_validator tag in a ParamBlockDesc2 constructor. Any parameter can have a custom validator. This is used by the scripter and node pick button filter for example. If you want to validate a parameter block 2 value create an instance of this class and implement the Validate() method.

#include <iparamb2.h>

Inheritance diagram for PBValidator:

List of all members.

Public Member Functions
virtual BOOL	Validate (PB2Value &v)=0
virtual BOOL	Validate (PB2Value &v, ReferenceMaker *owner, ParamID id, int tabIndex)
virtual void	DeleteThis ()

---

Member Function Documentation

virtual BOOL Validate

(

PB2Value &

v

)

[pure virtual]

Search for all occurrences

Remarks:

Returns TRUE if the given PB2Value if valid; otherwise FALSE.

Parameters:

PB2Value& v

The value to check.

virtual BOOL Validate	(	PB2Value &	v,
		ReferenceMaker *	owner,
		ParamID	id,
		int	tabIndex
	)		[inline, virtual]

Search for all occurrences

Remarks:

A variant of Validate() method to PBValidate which supplies more context than the original Validate(), effectively giving the same context information as the Set() & Get() methods in a PBAccessor.

Parameters:

PB2Value& v

The value to check.

ReferenceMaker* owner

Points to the owner of the parameter.

ParamID id

The permanent ID of the parameter.

int tabIndex

If the parameter is a Tab<> this is the zero based index of the parameter in the table.

{ return this->Validate(v); }

virtual void DeleteThis

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method that can be used to destroy dynamically allocated instances of this class.

Default Implementation:

{ }

{ };