Olympe SDK

Interface: ValueDef

olympe.dc. ValueDef

A ValueDef is an object that specifies how to access a value, for instance a property of an instance or a constant.

Methods

<abstract> getInternalPath()

Returns the path in the graph followed by this valuedef to be evaluated.

Returns:
Type
Array.<!olympe.dc.query.Relation>

<abstract> getName()

Gets the name of this ValueDef.

Returns:

The name of this ValueDef.

Type
string

<abstract> getValue(manager, tag)

Gets the value defined by this ValueDef.

Parameters:
Name Type Description
manager olympe.dc.Manager

The DC manager.
tag string

The tag of the instance holding the value, if any.
Returns:

The value referenced by this ValueDef.

Type
olympe.df.Proxy.<T> | T

<abstract> serialize(parameters)

Serializes this ValueDef.

Parameters:
Name Type Description
parameters olympe.dc.query.Parameters

Serialization parameters.
Throws:

If the value def is not serializable.

Type
Error
Returns:

The string containing the serialized representation of the ValueDef.

Type
string

<abstract> toString()

Gets a string representation of the value def

Returns:

The string representation of this ValueDef.

Type
string