Region1D Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class that describes a 1D region. More...

Inheritance diagram for Region1D:

Public Member Functions
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.
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.
	Region1D (SerializationInfo info, StreamingContext context)
	Deserialization constructor. See the ISerializable interface for more details.
virtual void	UpdatePropertyOfCoordinates ()
	Method for handling update after change of the physical property of the coordinate.

Static Public Member Functions
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
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.

Properties
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 IRegion1D2D
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.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class that describes a 1D region.

Constructor & Destructor Documentation

Region1D() [1/3]

Region1D	(	bool	boundariesAreInside,
		PhysicalProperty	propertyOfCoordinates = PhysicalProperty::Length
	)

Constructor which gets the _boundariesAreInside flag. To be called from derived classes constructors.

Parameters

boundariesAreInside
propertyOfCoordinates	Physical property of the coordinate.

Region1D() [2/3]

Region1D

(

Region1D

region2bCopied

)

Copy constructor.

Parameters

region2bCopied

Region to be copied.

Region1D() [3/3]

Region1D	(	SerializationInfo	info,
		StreamingContext	context
	)

Deserialization constructor. See the ISerializable interface for more details.

Parameters

info	SerializationInfo
context	StreamingContext

Member Function Documentation

Clone()

override object Clone

(

)

Clones the current object.

Returns

Deep copy of this object.

Equals()

override bool Equals	(	object	obj,
		EqualityIntent	equalityIntent
	)

Equality operation.

Parameters

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

Returns

GetCoordinatesOfActualSubregionBorders()

double[] GetCoordinatesOfActualSubregionBorders ( ExtrapolationInfo  extrapolation2use )

abstract

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.

Parameters

extrapolation2use

The extrapolation to use.

Returns

The coordinates of the actual subregion borders.

GetInOutRelation()

InsideOutside GetInOutRelation ( double  point, ExtrapolationInfo  extrapolation2use = null  )

abstract

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.

InvertRegion()

static Region1D InvertRegion ( Region1D  region2Invert )

static

Creates a new region with inverted in / out regions compared to this.

Parameters

region2Invert

Region to be inverted.

Returns

A new region with inverted in / out regions compared to this.

IsInside()

bool IsInside

(

double

point

)

Method which checks whether or not a point is inside the 1D region.

Parameters

point

The point to be checked whether it lies inside.

Returns

true if point lies inside the 1D region.

Load()

static Region1D Load ( string  fileName )

static

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.

Parameters

fileName

Name of the file.

Returns

The specified document.

MayBeNonzeroOutside()

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.

Parameters

maybeNonZeroLeft	True, if there may be nonzero values left of the bounding interval.
maybeNonZeroRight	True, if there may be nonzero values right of the bounding interval.

operator!=()

static bool operator!= ( Region1D  o1, Region1D  o2  )

static

Unequals operator.

Parameters

o1
o2

Returns

operator==()

static bool operator== ( Region1D  o1, Region1D  o2  )

static

Equals operator.

Parameters

o1
o2

Returns

Translate()

static Region1D Translate ( Region1D  regionToShift, double  shift  )

static

Translates (shifts) a given region by a given value.

Parameters

regionToShift	Region to be shifted.
shift	Value to shift.

Returns

Shifted region.