Production Interface

Authors

Joe Starr, Ph.D.

I specialize in computational knot theory. I’m also a professional embedded software engineer.

Unit Description

classDiagram
    production *-- prd_config_t
    class production {
        << interface >>
        + char * production_uid
        + const char * prd_resolve(const void *config)
        + const char * prd_terminate(const void *config)
    }

    class prd_config_t {
        << struct >>
        +const char * prod_id;
    }

Functionality

Public Structures

Production Configuration Structure

The production configuration structure defines the collection of data the component needs for an 'instance'. A configuration should be considered equivalent to instantiating a class in a high-level language. This instance needs to contain all state information required for that class.

Public Functions

Resolve Function

When this function is invoked, the production process begins. The actual internal functionality is specific to the specific production. The function returns the string resulting from the production. In the case of a failure a NULL pointer is returned.

The flow for a production is modeled by the following state machine:

stateDiagram-v2
    state "Get config" as gd
    state "Produce a string" as wod
    [*] --> gd
    gd  -->  wod
    wod -->  [*]

Terminate Function

When this function is invoked, the production executes a special terminal case. The actual internal functionality is specific to the specific production. The function returns the string resulting from the termination. In the case of a failure a NULL pointer is returned.

The flow for a production termination is modeled by the following state machine:

A special termination case allows for production of 'truncated' words in a language when constraints are exceeded. The default termination is the empty string.

stateDiagram-v2
    state "Get config" as gd
    state "Produce a string" as wod
    [*] --> gd
    gd  -->  wod
    wod -->  [*]

---