Datum Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The Datum type exposes the following members.

Constructors

	Name	Description
	Datum	Initializes a new instance of the Datum class
	Datum(String)	Initializes a new instance of the Datum class
	Datum(String, DateTime)	Initializes a new instance of the Datum class

Methods

	Name	Description
	Aggregate	Aggregates events, for example from multiple threads into one
	AggregateEvent
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetViewGroupInterfaces	Returns Datum classification interfaces marked with InstrumentViewGroup attribute. The implementation is cached fr efficiency
	MakeAggregateInstance
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReduceSourceDetail	Override to set a new source value which is less-specific than existing source. ReductionLevel specifies how much detail should be lost. The function is idempotent, that is - calling more than once with the same arg does not change the state of the object. The default implementation removes all source details (unspecified source) when reductionLevel less than zero. Example: TotalBytesSent("mpx://45.12.123.19:7823 -> MySystem.Contracts.IDoSomething.SomeMethod1()") ReduceSourceDetail(0) -> yields original string ReduceSourceDetail(1) - > "MySystem.Contracts.IDoSomething.SomeMethod1()" ReduceSourceDetail(2) - > "MySystem.Contracts.IDoSomething" ReduceSourceDetail(3) - > ""
	SummarizeAggregation
	ToString	(Overrides Object ToString .)
	WriteAsJSON
	WriteJSONFields

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	BUSINESS_SOURCE
	FRAMEWORK_SOURCE
	m_Count
	m_Source
	m_UTCEndTime
	m_UTCTime
	UNSPECIFIED_SOURCE

Properties

	Name	Description
	Count	Returns count of measurements. This property may be gotten only if IsAggregated==true, otherwise zero is returned
	Description	Returns description for data that this datum represents. Base implementation returns full type name of this instance
	IsAggregated	Indicates whether this instance represents a rollup/aggregation of multiple events
	PlotValue	Provides numeric value used for charts
	Rate	Returns rate of occurrence string
	Source	Returns datum source. Data are rolled-up by type of recorded datum instances and source
	UTCEndTime	Returns UTC time stamp when event happened. This property may be gotten only if IsAggregated==true, otherwise UTCTime value is returned
	UTCTime	Returns UTC time stamp when event happened
	ValueAsObject	Provides access to value polymorphically
	ValueUnitName	Provides name for units that value is measured in
	ViewGroupInterfaces	Returns Datum classification interfaces marked with InstrumentViewGroup attribute. The implementation is cached fr efficiency