Class BoundSelectorPair
- Namespace
- Hi.Numerical.StepSelectionUtils
- Assembly
- HiMech.dll
Represents a pair of bound selectors defining the beginning and end of a step section.
public class BoundSelectorPair : IMakeXmlSource
- Inheritance
-
BoundSelectorPair
- Implements
- Inherited Members
- Extension Methods
Constructors
BoundSelectorPair(BoundSelector, BoundSelector)
Initializes a new instance of the BoundSelectorPair class with specified begin and end bound selectors.
public BoundSelectorPair(BoundSelector begin, BoundSelector end)
Parameters
begin
BoundSelectorThe beginning bound selector.
end
BoundSelectorThe ending bound selector.
BoundSelectorPair(XElement, string)
Ctor.
public BoundSelectorPair(XElement src, string baseDirectory)
Parameters
Properties
Begin
Gets the beginning bound selector.
public BoundSelector Begin { get; }
Property Value
End
Gets the ending bound selector.
public BoundSelector End { get; }
Property Value
XName
Name for XML IO.
public static string XName { get; }
Property Value
Methods
GetStepSectionBound(BoundLocale)
Gets the bound selector for the specified location.
public BoundSelector GetStepSectionBound(BoundSelectorPair.BoundLocale locale)
Parameters
locale
BoundSelectorPair.BoundLocaleThe location of the bound to retrieve.
Returns
- BoundSelector
The bound selector at the specified location.
MakeXmlSource(string, string)
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)
Parameters
baseDirectory
stringThe base directory for resolving relative paths
relFile
stringThe relative file path for the XML source
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.