GetRepositoryPiece2

 

 

Name

 

            GetRepositoryPiece2

 

When to use it

 

            After setting the size using the SetRepositoryPiece2 method and before the OnFinish event ends.

 

Prototype

 

            HRESULT GetRepositoryPiece2(

                        Index: Long/*[in]*/,

                        Length: Long/*[out]*/,

                        Cost: Double /*[out]*/

                        Priority: Long /*[out]*/

                        ExternalID: Long /*[out]*/

            );

 

Explanations

 

            GetRepositoryPiece2 returns information about each bar to be cut. This method extends the functionality of the GetRepositoryPiece method.

            The number of pieces to be cut is given by the NumberOfRepositoryPieces property.

            The information of each piece can be set using the SetRepositoryPiece2 method.

 

Parameters

 

            Index - the index of the piece whose information are extracted. This number is in range [0...NumberOfRepositoryPieces - 1].

            Length - the length of the piece.

            Cost - the cost of the entire bar.

            Priority - the priority to cut the repository piece. 0 is the highest priority.

            ExternalID is the external ID of the repository piece whose input index is Index. External ID is an integer number which was assigned to each piece in order to be easier identified.

 

 

Links

        back to index

        www.optimalprograms.com