annotate docs/modules/txt/ObjectProperty.txt @ 0:4816e4a8ae95 draft default tip

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