CLASS KTNEVComments

  KTNEVComments

  This is a class that deals with comments saved in a NEV file. The user
  can read the comments, get their timestamp information and even add
  comments to the NEV file and then save it as a new file.


    addComment:              Allows the user to add a new comment to the
                             file at a given timestamp.

    displayComments:         Displays all the comments in the NEV with their
                             corresponding timestamps.

    'report':                Will show a summary report if user passes this
                             argument.
                             DEFAULT: will not show report.

    getCommentText:          Displays the text of comments.

    getCommentTimestamps:    Displays the timestamp of comments, in samples.

    getCommentTimestampsSec: Displays the timestamp of comments, in seconds.

    EXAMPLE:

    To run, use "myVariable = KTNEVComments;". Then use
    "myVariable.METHODNAME" to call the various differnet methods. Type
    "myVariable." and then hit enter to see the available methods.

    myComments = KTNEVComments;
    myComments.DisplayComments;

    Kian Torab
    ktorab@blackrockmicro.com
    Blackrock Microsystems
    Version 1.0.1.0

Superclasses

none

Properties

none

Methods

Method	Description
addComment	KTNEVComments/addComment is a function.
displayComments	KTNEVComments/displayComments is a function.
getCommentText	KTNEVComments/getCommentText is a function.
getCommentTimestamps	KTNEVComments/getCommentTimestamps is a function.
getCommentTimestampsSec	KTNEVComments/getCommentTimestampsSec is a function.

Methods help

addComment - KTNEVComments/addComment is a function.

addComment(obj)

---

displayComments - KTNEVComments/displayComments is a function.

displayComments(obj)

---

getCommentText - KTNEVComments/getCommentText is a function.

output = getCommentText(obj)

---

getCommentTimestamps - KTNEVComments/getCommentTimestamps is a function.

output = getCommentTimestamps(obj)

---

getCommentTimestampsSec - KTNEVComments/getCommentTimestampsSec is a function.

output = getCommentTimestampsSec(obj)

---