Grid Solutions Framework Documentation

Grid Solutions Framework Documentation

TimeTagBase Class

TimeTagBase Constructor

TimeTagBase Properties

TimeTagBase Methods

TimeTagBase Operators

TimeTagBase Fields

Click or drag to resize

TimeTagBase Class

Represents the base class for alternate timetag implementations.

Inheritance Hierarchy

SystemObject
  GSFTimeTagBase
    GSF.HistorianTimeTag
    GSFNtpTimeTag
    GSFUnixTimeTag

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

[SerializableAttribute]
public abstract class TimeTagBase : ISerializable, 
	IComparable, IComparable<TimeTagBase>, IComparable<DateTime>, 
	IEquatable<TimeTagBase>, IEquatable<DateTime>, IFormattable

<SerializableAttribute>
Public MustInherit Class TimeTagBase
	Implements ISerializable, IComparable, IComparable(Of TimeTagBase), 
	IComparable(Of DateTime), IEquatable(Of TimeTagBase), IEquatable(Of DateTime), 
	IFormattable

[SerializableAttribute]
public ref class TimeTagBase abstract : ISerializable, 
	IComparable, IComparable<TimeTagBase^>, IComparable<DateTime>, 
	IEquatable<TimeTagBase^>, IEquatable<DateTime>, IFormattable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type TimeTagBase = 
    class
        interface ISerializable
        interface IComparable
        interface IComparable<TimeTagBase>
        interface IComparable<DateTime>
        interface IEquatable<TimeTagBase>
        interface IEquatable<DateTime>
        interface IFormattable
    end

GSF.TimeTagBase = function();

Type.createClass(
	'GSF.TimeTagBase',
	null,
	ISerializable,
	IComparable,
	IComparable`1,
	IComparable`1,
	IEquatable`1,
	IEquatable`1,
	IFormattable);

The TimeTagBase type exposes the following members.

Constructors

	Name	Description
	TimeTagBase(Int64, Ticks)	Creates a new TimeTagBase, given standard .NET DateTime.
	TimeTagBase(Int64, Decimal)	Creates a new TimeTagBase, given number base time (in ticks) and seconds since base time.
	TimeTagBase(SerializationInfo, StreamingContext)	Creates a new TimeTagBase from serialization parameters.

Properties

	Name	Description
	BaseDateOffsetTicks	Gets ticks representing the absolute minimum time of this timetag implementation.
	Value	Gets or sets number of seconds (including any fractional seconds) since base time.

Methods

	Name	Description
	CompareTo(DateTime)	Compares the TimeTagBase with a DateTime.
	CompareTo(Object)	Compares the TimeTagBase with the specified Object.
	CompareTo(TimeTagBase)	Compares the TimeTagBase with another TimeTagBase.
	Equals(DateTime)	Determines whether the specified DateTime is equal to the current TimeTagBase.
	Equals(Object)	Determines whether the specified Object is equal to the current TimeTagBase. (Overrides ObjectEquals(Object))
	Equals(TimeTagBase)	Determines whether the specified TimeTagBase is equal to the current TimeTagBase.
	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 a hash function for the current TimeTagBase. (Overrides ObjectGetHashCode)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToDateTime	Returns standard .NET DateTime representation for timetag.
	ToString	Returns basic textual representation for timetag. (Overrides ObjectToString)
	ToString(IFormatProvider)	Returns textual representation for timetag using the specified provider.
	ToString(String)	Returns textual representation for timetag in the specified format.
	ToString(String, IFormatProvider)	Returns textual representation for timetag in the specified format using the specified provider.

Operators

	Name	Description
	Equality(DateTime, TimeTagBase)	Returns true if value1 is equal to value2.
	Equality(TimeTagBase, TimeTagBase)	Returns true if value1 is equal to value2.
	Equality(TimeTagBase, DateTime)	Returns true if value1 is equal to value2.
	GreaterThan(DateTime, TimeTagBase)	Returns true if value1 is greater than value2.
	GreaterThan(TimeTagBase, TimeTagBase)	Returns true if value1 is greater than value2.
	GreaterThan(TimeTagBase, DateTime)	Returns true if value1 is greater than value2.
	GreaterThanOrEqual(DateTime, TimeTagBase)	Returns true if value1 is greater than or equal to value2.
	GreaterThanOrEqual(TimeTagBase, TimeTagBase)	Returns true if value1 is greater than or equal to value2.
	GreaterThanOrEqual(TimeTagBase, DateTime)	Returns true if value1 is greater than or equal to value2.
	Inequality(DateTime, TimeTagBase)	Returns true if value1 is not equal to value2.
	Inequality(TimeTagBase, TimeTagBase)	Returns true if value1 is not equal to value2.
	Inequality(TimeTagBase, DateTime)	Returns true if value1 is not equal to value2.
	LessThan(DateTime, TimeTagBase)	Returns true if value1 is less than value2.
	LessThan(TimeTagBase, TimeTagBase)	Returns true if value1 is less than value2.
	LessThan(TimeTagBase, DateTime)	Returns true if value1 is less than value2.
	LessThanOrEqual(DateTime, TimeTagBase)	Returns true if value1 is less than or equal to value2.
	LessThanOrEqual(TimeTagBase, TimeTagBase)	Returns true if value1 is less than or equal to value2.
	LessThanOrEqual(TimeTagBase, DateTime)	Returns true if value1 is less than or equal to value2.

Fields

	Name	Description
	DefaultFormat	Default format for TimeTagBase implementations.

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

See Also

Reference

See Grid Solutions Framework Project for latest code.

Copyright © 2018, Grid Protection Alliance. All Rights Reserved.

Send comments on this topic to GPA Development