IRegion1D2D Interface Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Interface to connect 1D and 2D regions. More...

Inheritance diagram for IRegion1D2D:

Public Member Functions
bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. More...
Public Member Functions inherited from IDocument
void	Reload ()
	Reload function for the document

Properties
bool	BoundariesAreInside [get, set]
	Gets or sets whether or not the boundaries of the region belong to the inner 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.
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.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Interface to connect 1D and 2D regions.

See also

System.ICloneable, VirtualLabAPI.Core.Common.IDocument

Member Function Documentation

Equals()

bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent
	)

Determines whether the specified Object is equal to this instance.

Parameters

otherObject	The Object to compare with this instance.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or physical equality.

Returns

true if the specified Object is equal to this instance; otherwise, false.

Implemented in ComposedRegion1D, Region1D, SampledRegion1D, ComposedRegion2D, EllipticRegion, RectangularRegion, Region2D, SampledRegion2D, SimplePolygon, and IntervalRegion.