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...

bool	Equals (PropertyNumeric other)

bool	Equals (PropertyNumeric other, double epsilon)

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...

virtual bool	Equals (Property other)

override bool	Equals (object obj)

override int	GetHashCode ()

Public Attributes
const double	DefaultEpsilonValue = 0.001
	The default numerical tolerance which is used when comparing values. More...

Protected Member Functions
override object	GetValue ()

Protected Member Functions inherited from Bexel.Api.Property
	Property (PropertyRef propertyRef, Project project)

Protected Member Functions inherited from Bexel.Api.ApiObject
virtual void	CheckValidity ()

Properties
override PropertyType	Type `[get]`

new double	Value `[get]`

Properties inherited from Bexel.Api.Property
override bool	IsValid `[get]`

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

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. If not provided the Bexel.Api.PropertyNumeric.DefaultEpsilonValue will be used.

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

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.

const double Bexel.Api.PropertyNumeric.DefaultEpsilonValue = 0.001

The default numerical tolerance which is used when comparing values.