51Degrees Pipeline .NET: FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T

Detailed Description

This class can be used where engines have a property that may be populated and may not.

It can be used to let the user know details of why a property value is not available. For example, if a property requires additional evidence from client side code before it can be populated.

Template Parameters: T - The type of data stored within the instance.

Inheritance diagram for FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >:

[legend]

Public Member Functions

	AspectPropertyValue () Default constructor. More...
	AspectPropertyValue (T value) Constructor. More...
override string	ToString ()

override bool Equals (object obj)

override int GetHashCode ()

Properties

string	NoValueMessage `[get, set]` The message in the Exception if the Value property is accessed and the instance does not have a set value. More...
bool	HasValue `[get]` True if this instance contains a value, false otherwise. More...
T	Value `[get, set]` Get/set the underlying value. More...

Constructor & Destructor Documentation

◆ AspectPropertyValue() [1/2]

FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >.AspectPropertyValue

(

)

Default constructor.

Used to create an instance with no initial underlying value.

◆ AspectPropertyValue() [2/2]

FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >.AspectPropertyValue

(

value

)

Constructor.

Used to create an instance with an underlying value.

Parameters: value - The underlying value to assign to this instance.

Property Documentation

◆ HasValue

bool FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >.HasValue

get

True if this instance contains a value, false otherwise.

◆ NoValueMessage

string FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >.NoValueMessage

get set

Initial value:

"This instance does not have a set value"

The message in the Exception if the Value property is accessed and the instance does not have a set value.

◆ Value

T FiftyOne.Pipeline.Engines.Data.AspectPropertyValue< T >.Value