PhysicalValuePair Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a pair of physical values. More...

Public Member Functions
	PhysicalValuePair (double value1, double value2, MeasuredQuantity measuredQuantity1, MeasuredQuantity measuredQuantity2)
	Constructor with the all parameters.
	PhysicalValuePair (double value1, double value2, PhysicalProperty property1, PhysicalProperty property2)
	Constructor with the most important parameters.
	PhysicalValuePair (double value1, double value2, string name1, string name2, MeasuredQuantity measuredQuantity1, MeasuredQuantity measuredQuantity2)
	Constructor with the all parameters.
	PhysicalValuePair (double value1, double value2, string name1, string name2, PhysicalProperty property1, PhysicalProperty property2)
	Constructor with the all parameters.
	PhysicalValuePair (PhysicalValue value1, PhysicalValue value2)
	Constructor with two physical value parameters.
	PhysicalValuePair (PhysicalValuePair pair)
	Copy constructor.
	PhysicalValuePair (VectorD value, MeasuredQuantity measuredQuantity)
	Constructor taking a VectorD.
override string	ToString ()
	Overridden ToString function.
VectorD	ToVectorD ()
	Returns a VectorD with the values of this pair.

Static Public Member Functions
static implicit	operator VectorD? (PhysicalValuePair physicalValuePair)
	Converts a PhysicalValuePair object into a VectorD object.
static bool	operator!= (PhysicalValuePair value1, PhysicalValuePair value2)
	Compares two PhysicalValuePair for inequality.
static bool	operator== (PhysicalValuePair pair1, PhysicalValuePair pair2)
	Compares two PhysicalValuePair for equality.

Properties
MeasuredQuantity	MeasuredQuantity1 [get, set]
	The measured quantity of value1.
MeasuredQuantity	MeasuredQuantity2 [get, set]
	The measured quantity of value2.
string	Name1 [get, set]
	Meaning of value1.
string	Name2 [get, set]
	Meaning of value2.
PhysicalProperty	PhysicalProperty1 [get, set]
	The physical property of value1.
PhysicalProperty	PhysicalProperty2 [get, set]
	The physical property of value2.
PhysicalValue	PhysicalValue1 [get]
	The value of the first physical value.
PhysicalValue	PhysicalValue2 [get]
	The value of the second physical value.
double	Value_X [get, set]
	First numerical value.
double	Value_Y [get, set]
	Second numerical value.
VectorD	Values [get]
	Gets the pair of values just as vactor of two doubles.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for a pair of physical values.

Constructor & Destructor Documentation

PhysicalValuePair() [1/7]

PhysicalValuePair	(	double	value1,
		double	value2,
		string	name1,
		string	name2,
		PhysicalProperty	property1,
		PhysicalProperty	property2
	)

Constructor with the all parameters.

Parameters

value1	First numerical value
value2	Second numerical value
name1	First value's name.
name2	Second value's name.
property1	The physical property of the physical value1.
property2	The physical property of the physical value2.

PhysicalValuePair() [2/7]

PhysicalValuePair	(	double	value1,
		double	value2,
		string	name1,
		string	name2,
		MeasuredQuantity	measuredQuantity1,
		MeasuredQuantity	measuredQuantity2
	)

Constructor with the all parameters.

Parameters

value1	First numerical value
value2	Second numerical value
name1	First value's name.
name2	Second value's name.
measuredQuantity1	The measured quantity of the physical value1.
measuredQuantity2	The measured quantity of the physical value2.

PhysicalValuePair() [3/7]

PhysicalValuePair	(	double	value1,
		double	value2,
		MeasuredQuantity	measuredQuantity1,
		MeasuredQuantity	measuredQuantity2
	)

Constructor with the all parameters.

Parameters

value1	First numerical value
value2	Second numerical value
measuredQuantity1	The measured quantity of the physical value1.
measuredQuantity2	The measured quantity of the physical value2.

PhysicalValuePair() [4/7]

PhysicalValuePair	(	double	value1,
		double	value2,
		PhysicalProperty	property1,
		PhysicalProperty	property2
	)

Constructor with the most important parameters.

Parameters

value1	First numerical value
value2	Second numerical value
property1	The physical property of the physical value1.
property2	The physical property of the physical value2.

PhysicalValuePair() [5/7]

PhysicalValuePair	(	VectorD	value,
		MeasuredQuantity	measuredQuantity
	)

Constructor taking a VectorD.

Parameters

value	The vector of doubles from which the physical value pair is constructed.
measuredQuantity	The measured quantity of the vector.

PhysicalValuePair() [6/7]

PhysicalValuePair	(	PhysicalValue	value1,
		PhysicalValue	value2
	)

Constructor with two physical value parameters.

Parameters

value1	First physical value
value2	Second physical value

PhysicalValuePair() [7/7]

PhysicalValuePair

(

PhysicalValuePair

pair

)

Copy constructor.

Parameters

pair	Physical value pair to copy

Member Function Documentation

operator VectorD?()

static implicit operator VectorD? ( PhysicalValuePair  physicalValuePair )

static

Converts a PhysicalValuePair object into a VectorD object.

Parameters

physicalValuePair

The VectorD object to convert into a VectorD object.

Returns

Converted VectorD object. Null if the physicalValuePair is null.

operator!=()

static bool operator!= ( PhysicalValuePair  value1, PhysicalValuePair  value2  )

static

Compares two PhysicalValuePair for inequality.

Parameters

value1	First PhysicalValuePair object to compare.
value2	Second PhysicalValuePair object to compare.

Returns

Returns true if the two objects are unequal.

operator==()

static bool operator== ( PhysicalValuePair  pair1, PhysicalValuePair  pair2  )

static

Compares two PhysicalValuePair for equality.

Parameters

pair1	First PhysicalValuePair object to compare.
pair2	Second PhysicalValuePair object to compare.

Returns

Returns true if the two objects are equal.

ToString()

override string ToString

(

)

Overridden ToString function.

Returns

The formatted value.

ToVectorD()

VectorD ToVectorD

(

)

Returns a VectorD with the values of this pair.

Returns

This instance as VectorD.