annotate mayachemtools/docs/modules/txt/ObjectProperty.txt @ 3:e420415a1799 draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 12:16:47 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 ObjectProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use ObjectProperty;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 ObjectProperty is an abstract base class which implements methods not
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 explicitly defined in classed derived from this class using Perl's
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 AUTOLOAD functionality. These methods are generated on-the-fly for a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 specified object property:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 Set<PropertyName>(<PropertyValue>);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 $PropertyValue = Get<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 Delete<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 This class uses its parent class hash to set, get, and delete propery
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 names and values.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 ObjectProperty module provides the following methods to be used in
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 context of its parent class:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 DeleteProperty, GetProperty, HasProperty, SetProperties, SetProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 DeleteProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 DeleteProperty($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 Deletes specified property *Name*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 GetProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 GetProperty($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 Returns value associated with specified property *Name*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 HasProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 HasProperty($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 Returns 1 or 0 based on whether specified property *Name* associated
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 with an object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 SetProperties
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 SetProperties(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 Using specified property name and value hash *NamesAndValues*,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 associates each property *Name* and *Values* to an object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 SetProperty
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 SetProperty($Name, $Value);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 Associate property *Name* and *Value* to an object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65