Skip to content

[FSvolLib] Create VolumeLibrary entry point class #5

Description

@BenCamps

For the redesigned Volume Library project we need to design a public interface for users of the volume library to call.

A VolumeLibrary class will serve as the public entry point. The primary mode of interacting with the VolumeLibrary will be its public static methods,
however to help with memory management it might be beneficial to utilize the singleton pattern. Initialization and freeing of resources can be handled by the class's constructor/destructor. Static methods will relay calls to the singleton instance.

classDiagram
    class VolumeLibrary {
        TreeOutput CalculateVolume(VolumeCalulationOptions options, TreeMeasurments treeData)

        TreeOutput CalculateVolume(VolumeCalulationOptions options, TreeMeasurments treeData, MerchRules merchRules)
        
        string GetVolumeEquationNumber(VolumeCalulationOptions options)

        real GetHeightAtDiamater(VolumeCalulationOptions options, TreeMeasurments treeData, real diameter)

        real GetDiameterAtHeight(VolumeCalulationOptions options, TreeMeasurments treeData, real height)

        int GetNumberOfLog(VolumeCalulationOptions options, TreeMeasurments treeData)

        string VersionNumber() 

        MerchRules GetDefaultMerchRules(VolumeCalculationOptions options)
    }
Loading

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions