|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
Overide the virtual functions to make a real planner.
Parent Classes:
Enumerated types:
- enum MaxIntT { MaxBest = 0x7fffffff } ;
-
| ind | Index of types of intererest. |
Variables:
- DPModelC model;
-
Model to use in planning.
| ind | Index of types of intererest. |
- IntT planCount;
-
| ind | Index of types of intererest. |
- PriQueueLC plans;
-
| ind | Index of types of intererest. |
Priority queue of plan/action pairs.
- VLIndexC conds;
-
| ind | Index of types of intererest. |
Index by preconditions.
Used to establish threats.
- UIntC allocCondID;
-
| ind | Index of types of intererest. |
Starts from 1.
Allocation counter for condition ID's.
- StepNodeT startNode;
-
| ind | Index of types of intererest. |
Inital node in plan.
- StepNodeT goalNode;
-
| ind | Index of types of intererest. |
Final node in plan.
- VLMinTermC init;
-
| ind | Index of types of intererest. |
Inital state
- VLStepC initS;
-
| ind | Index of types of intererest. |
Intial step.
- int maxSearch;
-
| ind | Index of types of intererest. |
How long to spend searching, Default:-1=Infinit.
- int limSearch;
-
| ind | Index of types of intererest. |
Max size of search, after a plan has been found.
- int curSearch;
-
| ind | Index of types of intererest. |
Number of plans considered so far.
- int bestSize;
-
| ind | Index of types of intererest. |
Size of best plan found so far.
- VLNonLinearPlanC bestPlan;
-
| ind | Index of types of intererest. |
Methods:
- VLNLPlannerBodyC()
-
Default constructor.
| ind | Index of types of intererest. |
- VLNLPlannerBodyC(const DPModelC<VLSymbC,VLSpaceC,VLMinTermC,VLMinTermC> & mod)
-
Constructor.
| ind | Index of types of intererest. |
- VLPlanLinearStepC Apply(const VLSpaceC & state,const VLMinTermC & goals)
-
Construct plan.
| ind | Index of types of intererest. |
- BooleanT NewPlan(const VLSpaceC & Start,const VLMinTermC & Goal)
-
Create a new plan.
| ind | Index of types of intererest. |
- BooleanT CompletePlan()
-
| ind | Index of types of intererest. |
Try and complete plan,
Ret: False=Failed.
- BooleanT IsComplete() const
-
| ind | Index of types of intererest. |
Is plan complete.
- BooleanT GetLinearPlan(VLPlanLinearStepC & LPlan)
-
| ind | Index of types of intererest. |
Create a linear plan.
- VLPlanLinearStepC GetBestLinearPlan(void) const
-
| ind | Index of types of intererest. |
Get best linear plan found so far.
- int GetBestSize(void) const
-
| ind | Index of types of intererest. |
Get size of best plan found so far.
- VLNonLinearPlanC & NLPlan()
-
| ind | Index of types of intererest. |
Get current plan.
- const VLNonLinearPlanC & NLPlan() const
-
| ind | Index of types of intererest. |
Get current plan.
- VLStepLstC ListSteps(const VLMinTermC & postCond)
-
| ind | Index of types of intererest. |
List steps with the given postcondition.
- VLStepLstC OptListSteps(const VLMinTermC & goalCond,const VLMinTermC & fullCond)
-
| ind | Index of types of intererest. |
GoalCond :- Condition that must be meet by Step,
FullCond :- 'Wish list' of conditions that also will be needed.
Heuristic ordering of steps, place the most likly to
be usefull first.
- int Distance(const VLMinTermC & MT1,const VLMinTermC & MT2)
-
| ind | Index of types of intererest. |
Find distance between two terms.
- void SetMaxSearch(int limit)
-
| ind | Index of types of intererest. |
Limit size of search.
- StepNodeT & StartNode()
-
| ind | Index of types of intererest. |
Access start node.
- const StepNodeT & StartNode() const
-
| ind | Index of types of intererest. |
Const access to start node.
- StepNodeT & GoalNode()
-
| ind | Index of types of intererest. |
Access to goal node.
- const StepNodeT & GoalNode() const
-
| ind | Index of types of intererest. |
Const access to goal node.
- StepListIDC PreCondID(const VLSymb & symb)
-
| ind | Index of types of intererest. |
Get ID for step precondition.
- StepListIDC PostCondID(const VLSymb & symb)
-
| ind | Index of types of intererest. |
Get ID for step postcondition.
- IntT GetPlanNo()
-
| ind | Index of types of intererest. |
Get an id for the current plan.
- void DoDBCheck(VLNonLinearPlan & aPlan)
-
| ind | Index of types of intererest. |
Debuging checks.
- void DoDBCheck(VLNonLinearPlanC aPlan)
-
| ind | Index of types of intererest. |
Debuging checks.
- VLPlanLinearStepC Apply(const VLSpaceC &,const VLMinTermC &)
-
Apply operation.
- IntT Apply(const SArray1dC<VLSpaceC> &,const SArray1dC<VLMinTermC> &,SArray1dC<VLPlanLinearStepC> & out)
-
Apply operation to an array.
- BooleanT Save(ostream & out) const
-
Save to ostream.
- const type_info & InputType() const
-
Get input type.
- const type_info & Input2Type() const
-
Get input type.
- const type_info & OutputType() const
-
Get input type.
- BooleanT Save(ostream & out) const
-
Save to ostream.
- const type_info & InputType() const
-
Get input type.
- const type_info & Input2Type() const
-
Get input type.
- const type_info & OutputType() const
-
Get input type.
- BooleanT Save(ostream & out) const
-
Save to ostream.
- const type_info & InputType() const
-
Get input type.
- const type_info & OutputType() const
-
Get input type.
- ProcTypeT OpType() const
-
Operation type lossy/lossless.
- BooleanT IsStateless() const
-
Is operation stateless ?
- BooleanT Save(ostream & out) const
-
Save to ostream.
- BodyRefCounterVC & Copy() const
-
Creat a copy of this object.
- BodyRefCounterVC & Copy() const
-
Creat a copy of this object.
- BooleanT operator==(const BodyRefCounterVC & oth) const
-
Compair identitys.
- BooleanT operator!=(const BodyRefCounterVC & oth) const
-
Compair identitys.
- BooleanT Save(ostream & out) const
-
Save to ostream.
- void AddReference()
-
Another reference to the object has been created.
- void RemoveReference()
-
One reference to the object was deleted.
Locking scheme
--------------
The object is possible to lock (to make constant). The scheme
assumes that the object is created, it can be locked, after that
it can only be destroyed. The locked object cannot be unlocked.
This locking scheme is very useful
during debugging, using assert() function,
when it is necassary to check that object
is treated as constant and the constancy is not violated by
any casting or passing through the copy constructor of shared
objects.
- void SetConst(void) const
-
This locks the object.
Often objects you wish to lock are already const.
- void SetConst(void)
-
This locks the object.
- BooleanT IsConst(void) const
-
Returns TRUE if the object is locked, ie. it is assumed to be constant.
- BooleanT IsNotConst(void) const
-
Returns TRUE if the object is unlocked.
ie. there is no special
information if the object is constant or not.
Counter state information
-------------------------
- BooleanT ToBeDeleted() const
-
Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
- BooleanT ToBeDeletedRemoveIgnoreNoRemove()
-
Decrement refrence by 1 return true if this leaves no refrences to the object.
- BooleanT ToBeDeletedRemove()
-
Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
- BooleanT BodyMightBeDeleted() const
-
Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
- BooleanT IsCountZero() const
-
Are there any refrences left ?
- BooleanT BRCPtrCanDeleteObject() const
-
Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
- IntT Count() const
-
Returns the current state of the counter, ie. how many references to this object exist.
- const BodyRefCounterC & operator=(const BodyRefCounterC & b)
-
It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
- BooleanT IsValidObject() const
-
Test if object is valid.
When amma check is disabled this always returns true.
- BooleanT UserBitTest(IntT x) const
-
Test user flag.
- void UserBitSet(IntT x,BooleanT setit = TRUE)
-
Test user flag.
- void UserBitZero(IntT x)
-
Set bit to zero.
- void ReportBRCError(char * Msg)
-
Report error, used in BRCPtrC.
- UIntT Hash() const
-
Hash on address of object.
- void SetUndeletable()
-
Make object undeletable.
Usefull to prevent recursive deleting in graph structures.
Only hackers need this function.
- void ReportInvalidObject(char * Msg = 0) const
-
Tell user about validation failure.
- LabelT Label() const
-
Returns the label of this reference counter.
The member function
is useful mainly to recognize objects during debugging.
The value of the label is uniquely defined pointer.
|
Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|