FgdEntityOutput

class fgdtools.FgdEntityOutput(name, value_type, description='')[source]

An entity output, as represented in a Fgd file.

__init__(name, value_type, description='')[source]

Creates an instance of FgdEntityOutput.

Parameters

  • name (str) – The output’s name.

  • value_type (str) – The output’s type.

  • description (str) – The output’s description.

__repr__()[source]

A partial, printable summary of a FgdEntityOutput.

Returns

A Python formated string.

Return type

str

property schema

A schematic view of this entity output’s attributes.

Returns

A dictionary.

Return type

dict

property name

The output’s name.

Return type

str

property value_type

The output’s type.

Return type

str

property description

The output’s description.

Return type

str

fgd_str()[source]

A string representation of the entity output. formated as in the a .fgd file

Returns

Fgd formated string.

Return type

str