annotate mayachemtool/mayachemtools/docs/modules/txt/ObjectProperty.txt @ 0:68300206e90d draft default tip

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