Class TCustomProperty

Unit

type TCustomProperty = class(TObject)

TCustomProperty is the abstract ancestor of real number, integer, and boolean properties.

(See TRProperty, TIProperty, and TBProperty.) A key method is IsIdentical which tests whether to TCustomPropertys are identical. Another is Assign which assigns the value of a data set at a particular location to the TCustomProperty.

	`FPhastInterpolationValues: TPhastInterpolationValues;`
	`FIsValue: boolean;`

	`function GetBValue: boolean; virtual;`
	`function GetIValue: integer; virtual;`
	`function GetRValue: double; virtual;`
	`procedure SetBValue(const Value: boolean); virtual;`
	`procedure SetIValue(const Value: integer); virtual;`
	`procedure SetPhastInterpolationValues( const Value: TPhastInterpolationValues);`
	`procedure SetRValue(const Value: double); virtual;`
	`procedure Assign(const DataSet: TDataArray; const LayerIndex, RowIndex, ColIndex: integer); virtual;`
	`function DataType: TPropertyType; virtual; abstract;`
	`function IsIdentical(AProperty: TCustomProperty): boolean; virtual; abstract;`
	`constructor Create;`
	`destructor Destroy; override;`

	`property BValue: boolean read GetBValue write SetBValue;`
	`property IValue: integer read GetIValue write SetIValue;`
	`property RValue: double read GetRValue write SetRValue;`
	`property Interpolation: TPhastInterpolationValues read FPhastInterpolationValues write SetPhastInterpolationValues;`
	`property IsValue: boolean read FIsValue;`

	`FPhastInterpolationValues: TPhastInterpolationValues;`
`FPhastInterpolationValues`: TPhastInterpolationValues; See Interpolation

	`FIsValue: boolean;`
See Interpolation `FIsValue` is used to say whether the zone contains a value or not.

	`function GetBValue: boolean; virtual;`
`GetBValue` returns `False`. In descendants it returns an actual value.

	`function GetIValue: integer; virtual;`
`GetIValue` returns 0. In descendants it returns an actual value.

	`function GetRValue: double; virtual;`
`GetRValue` returns 0.0. In descendants it returns an actual value.

	`procedure SetBValue(const Value: boolean); virtual;`
`SetBValue` does nothing. In descendants it sets a value.

	`procedure SetIValue(const Value: integer); virtual;`
`SetIValue` does nothing. In descendants it sets a value.

	`procedure SetPhastInterpolationValues( const Value: TPhastInterpolationValues);`
See Interpolation

	`procedure SetRValue(const Value: double); virtual;`
`SetRValue` does nothing. In descendants it sets a value.

	`procedure Assign(const DataSet: TDataArray; const LayerIndex, RowIndex, ColIndex: integer); virtual;`
`Assign` copies the value of DataSet at LayerIndex, RowIndex, ColIndex to the `TCustomProperty`. In `TCustomProperty`, all it does is set FIsValue.

	`function DataType: TPropertyType; virtual; abstract;`
`DataType` is used to specify what sort of data is stored in the `TCustomProperty`.

	`function IsIdentical(AProperty: TCustomProperty): boolean; virtual; abstract;`
`IsIdentical` returns true if the `TCustomProperty`'s are the same.

	`constructor Create;`
`Create` creates an instance of `TCustomProperty`.

	`destructor Destroy; override;`
`Destroy` destroys the current instance. Do not call Destroy directly. Call Free instead.

	`property BValue: boolean read GetBValue write SetBValue;`
`BValue` is an boolean value in the `TCustomProperty`.

	`property IValue: integer read GetIValue write SetIValue;`
`IValue` is an integer value in the `TCustomProperty`.

	`property RValue: double read GetRValue write SetRValue;`
`RValue` is an real-number value in the `TCustomProperty`.

	`property Interpolation: TPhastInterpolationValues read FPhastInterpolationValues write SetPhastInterpolationValues;`
If PHAST-style interpolation is used, `Interpolation` is used to save the interpolation parameters.

	`property IsValue: boolean read FIsValue;`
`IsValue` is used to tell whether or not the property has a value. In boundary conditions, zones often don't have a value.

Generated by PasDoc 0.12.1 on 2013-05-13 15:42:07