|
User Documentation |
|
Centre for Vision, Speech & Signal Processing |
Parent Classes:
Variables:
Methods:
- VLNonLinearPlan(VLNLPlannerBodyC & APlanner)
-
Constructor, Empty plan.
| ind | Index of types of intererest. |
- VLNonLinearPlan(const VLNonLinearPlan & oth)
-
| ind | Index of types of intererest. |
- ~VLNonLinearPlan()
-
Destructor.
| ind | Index of types of intererest. |
- BooleanT Init(const VLMinTermC & Start,const VLMinTermC & Goal)
-
Initalise plan.
| ind | Index of types of intererest. |
- StepNodeT InsStep(const VLStepC & Step,const VLMinTermC & Goal)
-
Insert a step into the plan
| ind | Index of types of intererest. |
- StepNodeT InsStep(const VLStepC & Step)
-
Insert a step into the plan.
| ind | Index of types of intererest. |
- CausalLinkT InsCausalLink(StepNodeT From,StepNodeT To,VLMinTermC & Cond)
-
Insert a causal link into the plan. Used to resolve open goals.
| ind | Index of types of intererest. |
- OrderLinkT InsOrderLink(StepNodeT From,StepNodeT To)
-
Insert an order link into the plan. Used to resolve threats.
| ind | Index of types of intererest. |
- BooleanT IsComplete(void) const
-
Is plan complete.
| ind | Index of types of intererest. |
- VLPlanLinearStepC GetLinear(void) const
-
Get a linear version of the plan.
| ind | Index of types of intererest. |
- void Dump(void) const
-
Dump current plan to stdout.
| ind | Index of types of intererest. |
- IntT Score(void) const
-
Give the plan a score for A* search.
| ind | Index of types of intererest. |
- const StepNodeT & StartNode() const
-
Const access to start node.
| ind | Index of types of intererest. |
- const StepNodeT & GoalNode() const
-
Const access to goal node.
| ind | Index of types of intererest. |
- VLNLPlannerBodyC & Planner()
-
Get planner.
| ind | Index of types of intererest. |
- VLBNPListIndexC<StepNodeT> & PreConds()
-
Access PreConditions.
| ind | Index of types of intererest. |
- const VLBNPListIndexC<StepNodeT> & PreConds() const
-
Access PreConditions.
| ind | Index of types of intererest. |
- VLBNPListIndexC<StepNodeT> & PostConds()
-
Access PostConditions.
| ind | Index of types of intererest. |
- const VLBNPListIndexC<StepNodeT> & PostConds() const
-
Access PostConditions.
| ind | Index of types of intererest. |
- IntT PlanID() const
-
Get a unique ID for the plan.
| ind | Index of types of intererest. |
- StepNodeT NodeObjH(BGraphTypesC::NodeHandleT H)
-
Convert a node handle to a ptr.
| ind | Index of types of intererest. |
- BooleanT IsValid(const StepNodeT & Oth) const
-
Check the handle is valid. (For debuging. )
| ind | Index of types of intererest. |
- BooleanT IsValid() const
-
Check plan is valid.
| ind | Index of types of intererest. |
- BooleanT IsUsefullNewStep(const VLStepC & mt,const StepNodeT & sn) const
-
Test if is usefull to add postcondition to this plan.
| ind | Index of types of intererest. |
Use to filter out the addition of useless steps.
sn is the step which has the open goal that caused mt to be considered
- void DoDBCheck()
-
Debuging checks.
| ind | Index of types of intererest. |
- 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.
- 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:48:08 2001
|