\r\n

51Degrees Pipeline Python  4.3

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_core
  • fiftyone_pipeline_core
  • aspectproperty_value
  • AspectPropertyValue

pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue Class Reference

Detailed Description

An AspectPropertyValue is a wrapper for a value It lets you check this wrapper has a value inside it If not value is set, a specific no value message is returned.

Inheritance diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue:

[legend]

Collaboration diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue:

[legend]

Public Member Functions

def  __init__ (self, no_value_message=None, value="noValue")
Constructor for AspectPropertyValue. More...
def  has_value (self)
Check if the AspectPropertyValue wrapper has a value inside it. More...
def  value (self)
Get the value out of the AspectPropertyValue wrapper Note that this will return an error (including no_value_message if set) if there is no value. More...
def  no_value_message (self)
If there is no value, get the reason for there not being a value. More...

Public Attributes

 noValueMessage

Constructor & Destructor Documentation

◆ __init__()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue.__init__ (   self,
  no_value_message = None,
  value = "noValue"  
)

Constructor for AspectPropertyValue.

@type value: mixed

Parameters
value - the property value to store

@type noValueMessage: string

Parameters
noValueMessage - if there is no value, the reason for there not being one

Member Function Documentation

◆ has_value()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue.has_value (   self )

Check if the AspectPropertyValue wrapper has a value inside it.

@rtype bool

Returns
whether there is a value

◆ no_value_message()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue.no_value_message (   self )

If there is no value, get the reason for there not being a value.

@rtype string

Returns
the no value message

◆ value()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.aspectproperty_value.AspectPropertyValue.value (   self )

Get the value out of the AspectPropertyValue wrapper Note that this will return an error (including no_value_message if set) if there is no value.

So check has_value() first to be sure.

@rtype mixed

Returns
the stored value