Bexel.Api.PropertyNumeric Class Reference

Represents a property which holds a numerical value. More...

Inheritance diagram for Bexel.Api.PropertyNumeric:

Public Member Functions
bool	ValueEquals (double other, double epsilon=DefaultEpsilonValue)
	Determines whether the specified number is equal by value to the current property. More...
override bool	ValueEquals (object obj)
	Determines whether the specified object is equal by value to the current property. More...
Public Member Functions inherited from Bexel.Api.Property
virtual bool	ValueEquals (Property other)
	Determines whether the specified property is equal by value to the current property. More...

Public Attributes
const double	DefaultEpsilonValue = 0.001
	The default numerical tolerance. More...

Additional Inherited Members
Properties inherited from Bexel.Api.Property
abstract PropertyType	Type [get]
	Returns the type of the property. More...
PropertyDefinition	Definiton [get]
	Returns the definition of the property. More...
string	Name [get]
	Returns the name of the property. More...
object	Value [get]
	Returns the value of the property. More...
Properties inherited from Bexel.Api.ApiObject
abstract bool	IsValid [get]
	Indicates if the API object is valid or not. More...

Detailed Description

Represents a property which holds a numerical value.

Member Function Documentation

ValueEquals() [1/2]

bool Bexel.Api.PropertyNumeric.ValueEquals	(	double	other,
		double	epsilon = DefaultEpsilonValue
	)

Determines whether the specified number is equal by value to the current property.

Parameters

other	The number to compare with the current property.
epsilon	The numerical tolerance when comparing two floating point numbers.

Returns

True if the specified number is equal by value to the current property, False otherwise.

ValueEquals() [2/2]

override bool Bexel.Api.PropertyNumeric.ValueEquals ( object  obj )

virtual

Determines whether the specified object is equal by value to the current property.

Parameters

obj	The object to compare with the current property.

Returns

True if the specified object is equal by value to the current property, False otherwise.

Reimplemented from Bexel.Api.Property.

Member Data Documentation

DefaultEpsilonValue

const double Bexel.Api.PropertyNumeric.DefaultEpsilonValue = 0.001

The default numerical tolerance.