Property ( antares.property.Property )

class antares.property.Property(name, atype, context, datatype, scale, description='')

This is the Property class. A property is initialized with its name, the context it belongs to, the datatype of its value, a scale, and the description of its value.

Param:name(string): name of the property Param:context(antares.context.Context): context the property belongs to Param:datatype(string): data type of the property value Param:scale(IntPair or FloatPair): the range to which the property value scales Param:scale(FloatPair): the range to which the property value scales Param:description(string): description of the property

Attributes Summary

vector	The vector of all the past values computed for the property.
description	A short description of the property.
name	The name of the property.
context	The context that the property belongs to.
datatype	The data type of the property.
annotation	Annotation for the most-recently computed value.
confidence	Confidence for the most-recently computed value.

Methods Summary

Attributes Documentation

vector = None

The vector of all the past values computed for the property. It is a Numpy array.

Type:numpy array

description = ''

A short description of the property.

Type:string

name = ''

The name of the property.

Type:string

context = ''

The context that the property belongs to.

Type:string

datatype = ''

The data type of the property. The valid data type could be one of the following: (1) a Python’s built-in primitive type (“boolean”, “int”, “float”, “string”), (2) a Python package (“timestamp”), or (3) a proprietary, composite object provided by ANTARES (antares.context.UncertainFloat, antares.context.ProbabilityCurve, antares.context.IntPair, antares.context.FloatPair, antares.context.TimePeriod) as are documented within the API.

Type:string

annotation

Annotation for the most-recently computed value.

Type:string

confidence

Confidence for the most-recently computed value.

Type:float

Methods Documentation