Mercurial > repos > deepakjadmin > mayatool3_test2
diff docs/modules/txt/ObjectProperty.txt @ 0:4816e4a8ae95 draft default tip
Uploaded
author | deepakjadmin |
---|---|
date | Wed, 20 Jan 2016 09:23:18 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/modules/txt/ObjectProperty.txt Wed Jan 20 09:23:18 2016 -0500 @@ -0,0 +1,65 @@ +NAME + ObjectProperty + +SYNOPSIS + use ObjectProperty; + +DESCRIPTION + ObjectProperty is an abstract base class which implements methods not + explicitly defined in classed derived from this class using Perl's + AUTOLOAD functionality. These methods are generated on-the-fly for a + specified object property: + + Set<PropertyName>(<PropertyValue>); + $PropertyValue = Get<PropertyName>(); + Delete<PropertyName>(); + + This class uses its parent class hash to set, get, and delete propery + names and values. + + ObjectProperty module provides the following methods to be used in + context of its parent class: + + DeleteProperty, GetProperty, HasProperty, SetProperties, SetProperty + + METHODS + DeleteProperty + DeleteProperty($Name); + + Deletes specified property *Name* + + GetProperty + GetProperty($Name); + + Returns value associated with specified property *Name*. + + HasProperty + HasProperty($Name); + + Returns 1 or 0 based on whether specified property *Name* associated + with an object. + + SetProperties + SetProperties(%NamesAndValues); + + Using specified property name and value hash *NamesAndValues*, + associates each property *Name* and *Values* to an object. + + SetProperty + SetProperty($Name, $Value); + + Associate property *Name* and *Value* to an object. + +AUTHOR + Manish Sud <msud@san.rr.com> + +COPYRIGHT + Copyright (C) 2015 Manish Sud. All rights reserved. + + This file is part of MayaChemTools. + + MayaChemTools is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 3 of the License, or (at + your option) any later version. +