DfsStaticItemDecoratorBase Class

Class for decorating an IDfsStaticItem. If used as is, it returns exactly what the decorated StaticItem does.

All methods are implemented virtual. Hence you can override just one method, if just that is to be changed, and the remainder will work as always.

Inheritance Hierarchy

SystemObject
DHI.Generic.MikeZero.DFSDfsItemDecoratorBase
DHI.Generic.MikeZero.DFSDfsStaticItemDecoratorBase

Namespace: DHI.Generic.MikeZero.DFS
Assembly: DHI.Generic.MIKEZero.DFS (in DHI.Generic.MIKEZero.DFS.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class DfsStaticItemDecoratorBase : DfsItemDecoratorBase, 
	IDfsStaticItem, IDfsItemInfo, IDfsSimpleItemInfo

Public Class DfsStaticItemDecoratorBase
	Inherits DfsItemDecoratorBase
	Implements IDfsStaticItem, IDfsItemInfo, IDfsSimpleItemInfo

public ref class DfsStaticItemDecoratorBase : public DfsItemDecoratorBase, 
	IDfsStaticItem, IDfsItemInfo, IDfsSimpleItemInfo

type DfsStaticItemDecoratorBase =  
    class
        inherit DfsItemDecoratorBase
        interface IDfsStaticItem
        interface IDfsItemInfo
        interface IDfsSimpleItemInfo
    end

The DfsStaticItemDecoratorBase type exposes the following members.

Constructors

	Name	Description
	DfsStaticItemDecoratorBase	Default constructor

Top

Properties

	Name	Description
	AxisConversionType	Type of conversion for the axis (Inherited from DfsItemDecoratorBase.)
	AxisConversionUnit	Desired unit to convert axis to (Inherited from DfsItemDecoratorBase.)
	ConversionType	Type of conversion for the data values (Inherited from DfsItemDecoratorBase.)
	ConversionUnit	Desired unit to convert to (Inherited from DfsItemDecoratorBase.)
	Data	Data. Can be cast to one of the basic array types, depending on DataType
	DataType	Type of data stored in item. (Inherited from DfsItemDecoratorBase.)
	ElementCount	Number of data elements in the axis. (Inherited from DfsItemDecoratorBase.)
	ItemNumber	Item number, in list of items. 1 based. (Inherited from DfsItemDecoratorBase.)
	Name	Name of item. (Inherited from DfsItemDecoratorBase.)
	OrientationAlpha	Orientation alpha A rotation in the x-y plane, measured counter-clockwise. (Inherited from DfsItemDecoratorBase.)
	OrientationPhi	Orientation Phi A rotation in the x-z plane, measured counter-clockwise. (Inherited from DfsItemDecoratorBase.)
	OrientationTheta	Orientation Theta A rotation in the y-z plane, measured counter-clockwise. (Inherited from DfsItemDecoratorBase.)
	Quantity	EUM quantity of item (Inherited from DfsItemDecoratorBase.)
	ReferenceCoordinateX	Reference coordinate X (Inherited from DfsItemDecoratorBase.)
	ReferenceCoordinateY	Reference coordinate Y (Inherited from DfsItemDecoratorBase.)
	ReferenceCoordinateZ	Reference coordinate Z (Inherited from DfsItemDecoratorBase.)
	SpatialAxis	Spatial axis of item. (Inherited from DfsItemDecoratorBase.)
	StaticItem	The IDfsStaticItem that is decorated
	UsedElementCount	Number of used data elements in the axis. For compressed files, this can differ from ElementCount (Inherited from DfsItemDecoratorBase.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetAxisUnitConversion	Sets the unit axis conversion for a specific item. (Inherited from DfsItemDecoratorBase.)
	SetOrientation	Update the orientation of the spatial axis. (Inherited from DfsItemDecoratorBase.)
	SetReferenceCoordinates	Update the reference coordinates of the spatial axis. (Inherited from DfsItemDecoratorBase.)
	SetUnitConversion	Sets the unit conversion for a specific item. (Inherited from DfsItemDecoratorBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

DHI.Generic.MikeZero.DFS Namespace