Navigation: ABC Library Reference > BufferedPairsClass > BufferedPairsClass Methods >====== BufferedPairsClass Functional Organization ============ Expected Use ====== | |
As an aid to understanding the BufferedPairsClass, it is useful to organize its methods into two large categories according to their expected use–the primary interface and the virtual methods. This organization reflects what we believe is typical use of the BufferedPairsClass methods.
Non-Virtual Methods
The Non-Virtual Methods, which you are likely to call fairly routinely from your program, can be further divided into three categories:
Housekeeping (one-time) Use:
Init | initialize the BufferedPairsClass object | |
AddPair(v) | add a field pair to the List property | |
Kill | shut down the BufferedPairsClass object |
(v)This method is also Virtual.
Occasional Use:
AssignLeftToRight | assign each “left” field to its “right” counterpart | |
AssignLeftToBuffer | assign each “left” field to its “buffer” counterpart | |
AssignRightToLeft | assign each “right” field to its “left” counterpart | |
AssignRightToBuffer | assign each “right” field to its “buffer” counterpart | |
AssignBufferToLeft | assign each “buffer” field to its “left” counterpart | |
AssignBufferToRight | assign each “buffer” field to its “right” counterpart | |
EqualLeftRight | return 1 if each left equal right, otherwise return 0 | |
EqualLeftBuffer | return 1 if each left equal buffer, otherwise return 0 | |
EqualRightBuffer | return 1 if right equal buffer, otherwise return 0 | |
ClearLeft | CLEAR each “left” field | |
ClearRight | CLEAR each “right” field |
Inappropriate Use:
These methods are inherited from the FieldPairsClass and typically are not used in the context of this (BufferedPairsClass) derived class.
AddItem | add a field pair from one source field | |
Equal | return 1 if each left equal right, otherwise return 0 |
Virtual Methods
Typically you will not call these methods directly. However, we anticipate you will often want to override these methods, and because they are virtual, they are very easy to override. These methods do provide reasonable default behavior in case you do not want to override them.
AddPair | add a field pair to the List property |