/misc/RdWpget

http://github.com/sbotond/phylosim · #! · 42 lines · 42 code · 0 blank · 0 comment · 0 complexity · bc6e940ea23bbf3e79f52c9fed797587 MD5 · raw file

  1. ###########################################################################/**
  2. #
  3. # @RdocMethod getWriteProtected
  4. #
  5. # @title "Check if the object is write protected"
  6. #
  7. # \description{
  8. # @get "title".
  9. # Write protected objects cannot be modified through get/set methods and virtual fields.
  10. # }
  11. #
  12. # @synopsis
  13. #
  14. # \arguments{
  15. # \item{this}{An object.}
  16. # \item{...}{Not used.}
  17. # }
  18. #
  19. # \value{
  20. # TRUE or FALSE
  21. # }
  22. #
  23. # \examples{
  24. #
  25. # # create an object
  26. # o<-Alphabet()
  27. # # toggle write protection
  28. # o$writeProtected<-TRUE
  29. # # check if it's write protected
  30. # getWriteProtected(o)
  31. # # check write protection via virtual field
  32. # o$writeProtected
  33. #
  34. # }
  35. #
  36. # @author
  37. #
  38. # \seealso{
  39. # @seeclass
  40. # }
  41. #
  42. #*/###########################################################################