Previous topic

SRelation Structure

Next topic

SUtterance

SRelationClass StructureΒΆ

speect class SRelationClass

The SRelationClass structure.

Protected Attributes
SObjectClass _inherit

Inherit from SObjectClass.

const char *(*const name)(const SRelation *self, s_erc *error)

Name function pointer.

Get the name of given relation.

Parameters:
  • self

    The given relation.

  • error

    Error code.

Return:

Pointer to the name of the given relation.

const SUtterance *(*const utt)(const SRelation *self, s_erc *error)

Utt function pointer.

Get the utterance of the given relation.

Parameters:
  • self

    The given relation.

  • error

    Error code.

Return:

Pointer to the utterance of the given relation.

SItem *(*const head)(const SRelation *self, s_erc *error)

Head function pointer.

Return the item at the head of the given relation.

Parameters:
  • self

    The given relation.

  • error

    Error code.

Return:

Pointer to the head item of the given relation.

SItem *(*const tail)(const SRelation *self, s_erc *error)

Tail function pointer.

Return the item at the tail of the given relation.

Parameters:
  • self

    The given relation.

  • error

    Error code.

Return:

Pointer to the tail item of the given relation.

SItem *(*const append)(SRelation *self, const SItem *toShare, s_erc *error)

Append function pointer.

Create a new item and append it to the end of the items in the given relation.

Parameters:
  • self

    The given relation.

  • toShare

    The item with which the newly created item will share it’s content. If NULL then a new content will be created for the appended item.

  • error

    Error code.

Return:

Pointer to the appended item as it is in the given relation.

SItem *(*const prepend)(SRelation *self, const SItem *toShare, s_erc *error)

Prepend function pointer.

Create a new item and prepend it to the front of the items in the given relation.

Parameters:
  • self

    The given relation.

  • toShare

    The item with which the newly created item will share it’s content. If NULL then a new content will be created for the prepended item.

  • error

    Error code.

Return:

Pointer to the prepended item as it is in the given relation.