CollectionSchemaField Class Documentation

classCollectionSchemaField

Namespace:datalogics_interface

Detailed Description

Parameters that are part of a schema's field may be set.

Referenced by

CollectionSchema

Uses types

SchemaFieldSubtype

Constructor & Destructor Documentation

CollectionSchemaField

CollectionSchemaField(const std::string &field_id, SchemaFieldSubtypesubtype)

Parameters

field_id: const std::string &

the schema field ID. The ID is used during creation and extraction of the schema field. It is the unique identifier of the schema field.

subtype: SchemaFieldSubtype

the schema field subtype. The subtypes are predefined. The value of this parameter must correspond to the one of the SchemaFieldSubtype enum values.

The constructor accepts identifier value and subtype required by the schema field.

~CollectionSchemaField

~CollectionSchemaField()

Member Function Documentation

get_editable

boolget_editable()

Returns:

whether edit mode is allowed or not.

GetEditable allows to obtain information about edit mode of the current field.

get_id

std::stringget_id()

Returns:

the unique field's id.

GetID allows to obtain the unique id with which schema field has been created.

get_index

intget_index()

Returns:

the index of the field.

GetIndex allows to obtain field index.

get_name

std::stringget_name()

Returns:

the field name.

GetName allows to obtain field name.

get_subtype

SchemaFieldSubtypeget_subtype()

Returns:

field subtype. One of the ShemaFieldSubtype enum values.

GetSubtype allows to obtain the field subtype.

get_visible

boolget_visible()

Returns:

true if current schema field is visible, false otherwise.

GetVisible allows to obtain information about filed visibility.

set_editable

voidset_editable(booleditable)

Parameters

editable: bool

pass true to allow to edit this field or false otherwise.

Returns:

void

SetEditable allows to change edit mode for shema field. Its value false by default.

set_index

voidset_index(intindex)

Parameters

index: int

field index.

Returns:

void

NOTE: the field indexes are zero-based in ascending order without gaps.

set_name

voidset_name(const std::string &name)

Parameters

name: const std::string &

the new field name.

Returns:

void

SetName allows to change field name.

set_visible

voidset_visible(boolvisible)

Parameters

visible: bool

the visibility flag.

Returns:

void

SetVisible allows to set field's default visibility. Its value true by default.