IntervalRegion Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a simple, real valued coordinate interval, representing a 1D region. More...

Inheritance diagram for IntervalRegion:

Public Member Functions
override object	Clone ()
	Deep copy of the object.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Checks whether another IGraphicsAddOnObjectXD is equal to this.
override double[]	GetCoordinatesOfActualSubregionBorders (ExtrapolationInfo extrapolation2use)
override int	GetHashCode ()
override InsideOutside	GetInOutRelation (double point, ExtrapolationInfo extrapolation2use=null)
	Method which checks whether or not a point lies inside or outside the 1D region or on its boundary.
	IntervalRegion ()
	Default constructor, creating an interval of width 10mm, centered at 0.
	IntervalRegion (double center, double width, bool boundaryIsInside=false, PhysicalProperty propertyOfCoordinates=PhysicalProperty.Length)
	Constructor with all field parameters.
	IntervalRegion (IntervalRegion intervalRegion)
	Copy constructor.
override void	Save (string fileName)
	Save this region to a file with a given name.
Public Member Functions inherited from Region1D
override object	Clone ()
	Clones the current object.
override bool	Equals (object obj, EqualityIntent equalityIntent)
	Equality operation.
double[]	GetCoordinatesOfActualSubregionBorders (ExtrapolationInfo extrapolation2use)
	Method that gets the coordinates where a real subregion starts or ends. It doesn't contain borders of subregions which are no real borders but only those, where the inside/outside state changes.
override int	GetHashCode ()
InsideOutside	GetInOutRelation (double point, ExtrapolationInfo extrapolation2use=null)
	Method which checks whether or not a point lies inside or outside the 1D region or on its boundary.
override FormDocument	GetNewDocumentWindow (Form formMain, string fileName)
	Gets a new document window containing this document. Parameters formMain Reference to the main form (= MDI parent). Can be null if this form will not be shown (e.g. if it is generated just to get the view settings. fileName File name from which the document was opened for inserting into window caption. If this string is empty, the default document name is used. Returns A FormDocument containing this document.
bool	IsInside (double point)
	Method which checks whether or not a point is inside the 1D region.
void	MayBeNonzeroOutside (out bool maybeNonZeroLeft, out bool maybeNonZeroRight)
	Method which determines whether or not the region can provide "inside" state outside of its boundary interval. This is not the case for extrapolation mode 'ConstantZero', of course.
	Region1D (bool boundariesAreInside, PhysicalProperty propertyOfCoordinates=PhysicalProperty.Length)
	Constructor which gets the _boundariesAreInside flag. To be called from derived classes constructors.
	Region1D (Region1D region2bCopied)
	Copy constructor.
virtual void	UpdatePropertyOfCoordinates ()
	Method for handling update after change of the physical property of the coordinate.

Properties
override PhysicalValueRange	BoundingInterval [get]
	Gets the bounding interval for the 1D region.
double	Center [get, set]
	Gets and sets the center of the interval region.
double	Left [get]
	Gets the left boundary of the interval region.
double	Right [get]
	Gets the right boundary of the interval region.
double	Width [get, set]
	Gets and sets the width of the interval region.
Properties inherited from Region1D
bool	BoundariesAreInside [get, set]
	Gets or sets whether or not the boundaries of the region belong to the inner region.
PhysicalValueRange	BoundingInterval [get]
	Gets the bounding interval for the 1D region.
string	CommentOfCoordinates [get, set]
	Gets and sets the comment for the coordinates.
ExtrapolationInfo	ExtrapolationHandling [get, set]
	The extrapolation mode for this region.
bool	IsOneD [get]
	Gets whether this IRegion1D2D is 1D or 2D.
string	Name [get, set]
	The name which can be given to the region by the user.
PhysicalProperty	PropertyOfCoordinates [get, set]
	Physical property of the coordinates of the region.
Region1DType	RegionType [get]
	Gets the type of the region.
SamplingParameters	SamplingForUsageWithComplexFields [get, set]
	Sampling parameters which will be used for a coordinate rescaling in case of using the region with a complex field.
Properties inherited from IDocument
VirtualLabSession	Session [get, set]
	every documents need to be handled in a session ==> default is the VirtualLab Mainsession
NodeVLExplorer	TreeStructure [get]
	every document should have a node (maybe with subnodes) in the VirtualLab Explorer
DocumentType	TypeOfDocument [get]
	Gets an enum entry specifying the type of the document.

Additional Inherited Members
Static Public Member Functions inherited from Region1D
static Region1D	InvertRegion (Region1D region2Invert)
	Creates a new region with inverted in / out regions compared to this.
static Region1D	Load (string fileName)
	Loads the specified file name. Works independently from whether the document has been saved without view settings (as prior to VL 6.0) or with view settings.
static bool	operator!= (Region1D o1, Region1D o2)
	Unequals operator.
static bool	operator== (Region1D o1, Region1D o2)
	Equals operator.
static Region1D	Translate (Region1D regionToShift, double shift)
	Translates (shifts) a given region by a given value.
Static Public Attributes inherited from Region1D
const string	DefaultDocumentName
	The default document name (= type description) for an Order Collection.
static readonly string	FileDialogFilterString
	The filter string used in "Open File" dialogs.
const string	FileExtensionString
	The file extension for an Order Collection.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a simple, real valued coordinate interval, representing a 1D region.

Constructor & Destructor Documentation

IntervalRegion() [1/2]

IntervalRegion	(	double	center,
		double	width,
		bool	boundaryIsInside = false,
		PhysicalProperty	propertyOfCoordinates = PhysicalProperty::Length )

Constructor with all field parameters.

Parameters

center	Center of the interval.
width	Width of the interval.
boundaryIsInside	Flag which says whether or not the boundary is part of the inner region or not.
propertyOfCoordinates	Physical property of the coordinates.

IntervalRegion() [2/2]

IntervalRegion

(

IntervalRegion

intervalRegion

)

Copy constructor.

Parameters

intervalRegion

The interval region to be copied.

Member Function Documentation

Clone()

override object Clone

(

)

Deep copy of the object.

Returns

A deep copy of this.

Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent )

Checks whether another IGraphicsAddOnObjectXD is equal to this.

Parameters

otherObject	IGraphicsAddOnObjectXD to be checked.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or physical equality.

Returns

True if other IGraphicsAddOnObjectXD is equal to this.

GetInOutRelation()

override InsideOutside GetInOutRelation	(	double	point,
		ExtrapolationInfo	extrapolation2use = null )

Method which checks whether or not a point lies inside or outside the 1D region or on its boundary.

Parameters

point	The point to be checked whether it lies inside.
extrapolation2use	Extrapolation info actually to be used.

Returns

Information where the point lies in relation to the region.

Save()

override void Save

(

string

fileName

)

Save this region to a file with a given name.

Parameters

fileName