Class FileTimeSection

Namespace

Hi.Mappings

Assembly

HiGeom.dll

Represents a section of a file defined by a time range.

public class FileTimeSection : IMakeXmlSource

Inheritance

object

FileTimeSection

Implements

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)

XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)

XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string)

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

FileTimeSection()

Initializes a new instance of the FileTimeSection class.

public FileTimeSection()

FileTimeSection(string, Range<TimeSpan>)

Initializes a new instance of the FileTimeSection class with a file and time range.

public FileTimeSection(string file, Range<TimeSpan> range)

Parameters

file string

The file path.

range Range<TimeSpan>

The time range.

FileTimeSection(string, TimeSpan, TimeSpan)

Initializes a new instance of the FileTimeSection class with a file and begin/end times.

public FileTimeSection(string file, TimeSpan beginTime, TimeSpan endTime)

Parameters

file string

The file path.

beginTime TimeSpan

The begin time.

endTime TimeSpan

The end time.

FileTimeSection(XElement)

Initializes a new instance of the FileTimeSection class from XML.

public FileTimeSection(XElement src)

Parameters

src XElement

The XML element containing the file time section data.

Properties

BeginTime

Gets or sets the begin time as a TimeSpan.

public TimeSpan BeginTime { get; set; }

Property Value

TimeSpan

BeginTime_s

Gets or sets the begin time in seconds.

public double BeginTime_s { get; set; }

Property Value

double

Duration_s

Gets the duration in seconds.

public double Duration_s { get; }

Property Value

double

EndTime

Gets or sets the end time as a TimeSpan.

public TimeSpan EndTime { get; set; }

Property Value

TimeSpan

EndTime_s

Gets or sets the end time in seconds.

public double EndTime_s { get; set; }

Property Value

double

File

Gets or sets the file path.

public string File { get; set; }

Property Value

string

PrimaryTimeOption

Gets or sets the primary time option for XML serialization.

public FileTimeSection.TimeOption PrimaryTimeOption { get; set; }

Property Value

FileTimeSection.TimeOption

TimeRange

Gets or sets the time range.

public Range<TimeSpan> TimeRange { get; set; }

Property Value

Range<TimeSpan>

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

MakeXmlSource(string, string, bool)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.