Documentation for Prolog Module: plo

General Information:

plo is an object oriented extension for prolog.

Authored by:

• Salvador Fandiño García

Date:

15 Nov 2004

Predicates:

• oattr_get/3

• oattr_get/4

• oattr_reset/3

• oattr_reset/4

• oattr_set/3

• oattr_set/4

• oattr_seta/3

• oattr_seta/4

• oattr_unset/2

• oattr_unset/3

• oattr_unset/4

• oattr_unset_all/2

• oattr_unset_all/3

• oattr_unset_all/4

• ocheck_object/2

• ocheck_object/3

• oclass/3

• ocompile_method/2

• ocompile_methods/2

• odelete/1

• oinstance/2

• oisa/2

• omake/2

• omethod/2

• omethod/3

• omethod/4

• omethod/5

• omethoda/2

• omethoda/3

• omethoda/4

• onew/2

• onew/3

• onew_class/1

• onew_class/2

• onew_class/3

• oregister/2

• oregister_send_dispatcher_shortcut/1

• oretract_method/2

• osend/2

• osend/3

• ounregister_send_dispatcher_shortcut/1

Predicate Details:

• oattr_get/3

  Form:

  oattr_get(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Unrestricted: Value

  Description:

  retrieves value (or values via backtracking) for object attribute.

• oattr_get/4

• oattr_reset/3

  Form:

  oattr_reset(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Ground: Value

  Description:

  unsets all values of object attribute and sets it to new value Value.

• oattr_reset/4

• oattr_set/3

  Form:

  oattr_set(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Ground: Value

  Description:

  sets a new value for object attribute

• oattr_set/4

• oattr_seta/3

  Form:

  oattr_set(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Ground: Value

  Description:

  sets a new value for object attribute at the head (think assert/1 and asserta/1).

• oattr_seta/4

• oattr_unset/2

  Form:

  oattr_unset(Obj, Attr)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  Description:

  calls oattr_unset(Obj, Attr, _).

• oattr_unset/3

  Form:

  oattr_unset(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Unrestricted: Value

  Description:

  unsets object attribute value matching Value

• oattr_unset/4

• oattr_unset_all/2

  Form:

  oattr_unset_all(Obj, Attr)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  Description:

  calls oattr_unset_all(Obj, Attr, _).

• oattr_unset_all/3

  Form:

  oattr_unset_all(Obj, Attr, Value)

  Constraints:

  • Ground: Obj

  • Ground: Attr

  • Unrestricted: Value

  Description:

  unsets all values of object attribute matching Value

• oattr_unset_all/4

• ocheck_object/2

  Form:

  ocheck_object(Obj, Class)

  Constraints:

  • Ground: Obj

  • Unrestricted: Class

  Description:

  checks that Obj is a valid object of a class that unifies with Class.

• ocheck_object/3

• oclass/3

  Form:

  oclass(Obj, Class, MetaClass)

  Constraints:

  • Unrestricted: Obj

  • Unrestricted: Class

  • Unrestricted: MetaClass

  Description:

  relation pairing objects and classes. MetaClass is included for performance.

• ocompile_method/2

  Form:

  ocompile_method(Class, Name/Arity)

  Constraints:

  • Ground: Class

  • Ground: Name

  • Ground: Arity

  Description:

  compiles method with name Name and arity Arity on class Class

• ocompile_methods/2

  Form:

  ocompile_methods(Class, List)

  Constraints:

  • Ground: Class

  • Ground: List = [Name1/Arity1, Name2/Arity2, ...]

  Description:

  as ocompile_method/2 but accepts a list of method name/arity pairs.

• odelete/1

  Form:

  odelete(Obj)

  Constraints:

  • Ground: Obj

  Description:

  calls the method Class::delete_instance(Obj), being Class the class of Obj.

  Use this predicate to delete objects.

• oinstance/2

  Form:

  oinstance(Class, Obj)

  Constraints:

  • Ground: Class

  • Unrestricted: Obj

  Description:

  iterates over all the instances of class Class

• oisa/2

  Form:

  oisa(Obj, Class)

  Constraints:

  • Ground: Obj

  • Unrestricted: Class

  Description:

  iterates over all the classes Obj belongs to

• omake/2

  Form:

  omake(Class, Obj)

  Constraints:

  • Ground: Class

  • Ground: Obj

  Constraints:

  • Ground: Class

  • Unground: Obj

  Description:

  calls Class::make(Obj).

  Usually, you will not use this predicate but onew/2 or onew/3, that call the init/1 method on the new constructed object.

• omethod/2

  Form:

  omethod(Class, Fact)

  Constraints:

  • Ground: Class

  • Ground: Fact

  Description:

  defines a new method without body for class Class. Equivalent to omethod(Class, Fact, true).

• omethod/3

  Form:

  omethod(Class, Head, Body)

  Constraints:

  • Ground: Class,

  • Ground: Head,

  • Ground: Body

  Description:

  defines a new method Method with body Body on class Class.

• omethod/4

• omethod/5

• omethoda/2

  Form:

  omethoda(Class, Fact)

  Constraints:

  • Ground: Class

  • Ground: Fact

  Description:

  defines a new method without body for class Class and insert it before any other definition for the same method (think on assert/1 asserta/1). Equivalent to omethoda(Class, Fact, true).

• omethoda/3

  Form:

  omethoda(Class, Head, Body)

  Constraints:

  • Ground: Class,

  • Ground: Head,

  • Ground: Body

  Description:

  similar to omethod/3 but inserts the new method definition at the head.

• omethoda/4

• onew/2

  Form:

  onew(Class, Obj)

  Constraints:

  • Ground: Class

  • Ground: Obj

  Constraints:

  • Ground: Class

  • Unground: Obj

  Description:

  calls onew(Class, Obj, [])

• onew/3

  Form:

  onew(Class, Obj, Args)

  Constraints:

  • Ground: Class

  • Ground: Obj

  • Unrestricted: Args

  Constraints:

  • Ground: Class

  • Unground: Obj

  • Unrestricted: Args

  Description:

  calls Class::make(Obj) and then Obj::init(Args) when init/1 method is defined in Class.

  Use this predicate (or onew/2) to create new objects.

• onew_class/1

  Form:

  onew_class(Name)

  Constraints:

  • Ground: Name

  Description:

  creates a new class of metaclass 'rootmc' and no parents

• onew_class/2

  Form:

  onew_class(Name, Parents)

  Constraints:

  • Ground: Name

  • Ground: Parents

  Description:

  creates a new class with parents Parents. Class metaclass is the same as that of the first parent class.

• onew_class/3

  Form:

  onew_class(Name, Parents, Metaclass)

  Constraints:

  • Ground: Name

  • Ground: Parents

  • Ground: Metaclass

  Description:

  similar to onew_class/2 but allows to explicitly set the Metaclass for the new class. No check is performed to ensure that all parent classes are compatible with the selected metaclass.

• oregister/2

• oregister_send_dispatcher_shortcut/1

• oretract_method/2

  Form:

  oretract_method(Class, Method)

  Constraints:

  • Ground: Class,

  • Ground: Method

  Description:

  retracts first method matching Method from class Class

• osend/2

  Form:

  osend(Obj, Method)

  Constraints:

  • Ground: Obj

  • Ground: Method

  Description:

  calls method Method on Obj.

• osend/3

  Form:

  osend(Class, Obj, Method)

  Constraints:

  • Ground: Class

  • Ground: Obj

  • Ground: Method

  Description:

  calls method Method from class Class on Obj.

  Use this method to call methods defined on parent classes (it is not checked that Obj belongs to class Class).

  This contruction can also be used to simulate C++ static methods, i.e,
  :- osend(klass, [], foo(Bar)).

• ounregister_send_dispatcher_shortcut/1

Copyright (c) 2004 Salvador Fandiño García