IlvStIPreconditionValue Class Reference

Inspector class. More...

#include <ivstudio/inspectors/precond.h>

Inheritance diagram for IlvStIPreconditionValue:

Public Member Functions
	IlvStIPreconditionValue (IlvStIPropertyAccessor *accessor, const IlvStValue &valueToCompare, const IlvStValue &defaultValue)
	Initializes a new instance of IlvStIPreconditionValue. More...
virtual IlBoolean	isAccessible (IlvStIProperty **=0, IlvStIPropertyAccessor::PropertyStatus *=0) const
	Returns IlTrue if the test succeeds. More...

Detailed Description

Inspector class.

Library: ivstudio

This class compares the value returned by an accessor with a user value.

See also

IlvStIPrecondition.

Constructor & Destructor Documentation

IlvStIPreconditionValue::IlvStIPreconditionValue	(	IlvStIPropertyAccessor *	accessor,
		const IlvStValue &	valueToCompare,
		const IlvStValue &	defaultValue
	)

Initializes a new instance of IlvStIPreconditionValue.

Parameters

accessor	The accessor which provides the value.
valueToCompare	The user value.
defaultValue	The default value, If the test fails, this value will be used in place of the tested value.

Member Function Documentation

virtual IlBoolean IlvStIPreconditionValue::isAccessible ( IlvStIProperty **  props = 0, IlvStIPropertyAccessor::PropertyStatus *  status = 0  ) const

virtual

Returns IlTrue if the test succeeds.

The two parameters are set by the method if the test fails. They indicate the correct value to be used in place of the tested value and the access right to this value, respectively. Setting these values is optional.

Parameters

props	Contains the correct property when the test fails.
status	Contains the correct access right when the test fails.

Returns

IlTrue if the test succeeds and IlFalse otherwise.

Implements IlvStIPrecondition.