FgdEntityInput

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

An entity input, as represented in a Fgd file.

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

Creates an instance of FgdEntityInput.

Parameters

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

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

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

__repr__()[source]

A partial, printable summary of a FgdEntityInput.

Returns

A Python formated string.

Return type

str

property schema

A schematic view of this entity input’s attributes.

Returns

A dictionary.

Return type

dict

property name

The input’s name.

Return type

str

property value_type

The input’s type.

Return type

str

property description

The input’s description.

Return type

str

fgd_str()[source]

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

Returns

Fgd formated string.

Return type

str