Li Class Reference

AIML class that represents the AIML XML tag "li". More...

#include <Li.h>

Inheritance diagram for Li:

InnerTemplateListImpl InnerTemplate InnerCategory InnerTopic InnerAIML Tag List of all members.

Public Member Functions

virtual StringPimpl getAimlPattern () const throw (InternalProgrammerErrorException &)
 Returns the string set from the "value" attribute sent to Li::setAttribute().
virtual StringPimpl getPredicateName () const throw (InternalProgrammerErrorException &)
 Returns the string set from the "name" attribute sent to Li::setAttribute().
virtual bool isDefaultListItem () const throw (InternalProgrammerErrorException &)
 Returns true if this is a default list item or not.
virtual bool isNameAndValueListItem () const throw (InternalProgrammerErrorException &)
 Returns true if this is a name and value list item.
virtual bool isValueOnlyListItem () const throw (InternalProgrammerErrorException &)
 Returns true if this is a value only list item.
 Li () throw (InternalProgrammerErrorException &)
 Default constructor to initalize the private implementation (m_pimpl) data.
virtual void setAttribute (const StringPimpl &name, const StringPimpl &value) throw (InternalProgrammerErrorException &)
 Sets its attribute of "name" and "value".
virtual ~Li ()
 Default virtual destructor.

Private Attributes

shared_ptr< LiImpl > m_pimpl
 The private implementation in which you cannot get access to.

Detailed Description

AIML class that represents the AIML XML tag "li".

Every time a XML Tag of AIML is encountered, an instance of this class will be created. All text inbetween the begin and end tag, all attributes, and all inner Tags will go through methods of this class.


Constructor & Destructor Documentation

Li  )  throw (InternalProgrammerErrorException &)
 

Default constructor to initalize the private implementation (m_pimpl) data.

Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual ~Li  )  [virtual]
 

Default virtual destructor.

Destroys the private implementation (m_pimpl) data.


Member Function Documentation

virtual StringPimpl getAimlPattern  )  const throw (InternalProgrammerErrorException &) [virtual]
 

Returns the string set from the "value" attribute sent to Li::setAttribute().

Returns:
Returns the string set from the "value" attribute.
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual StringPimpl getPredicateName  )  const throw (InternalProgrammerErrorException &) [virtual]
 

Returns the string set from the "name" attribute sent to Li::setAttribute().

Returns:
Returns the string set from the "name" attribute.
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual bool isDefaultListItem  )  const throw (InternalProgrammerErrorException &) [virtual]
 

Returns true if this is a default list item or not.

An li element of the type defaultListItem has no attributes. It may contain any AIML template elements. In other words if the li does not have a "value" attribute or a "name" attribute it is a default list item.

Returns:
Returns boolean true if this is a default list item otherwise it will return false.
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual bool isNameAndValueListItem  )  const throw (InternalProgrammerErrorException &) [virtual]
 

Returns true if this is a name and value list item.

An li element of the type nameValueListItem has a required attribute name, which specifies an AIML predicate, and a required attribute value, which contains a simple pattern expression. The element may contain any AIML template elements.

Returns:
Returns boolean true if this is a name and value list item otherwise it will return false.
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual bool isValueOnlyListItem  )  const throw (InternalProgrammerErrorException &) [virtual]
 

Returns true if this is a value only list item.

An li element of the type valueOnlyListItem has a required attribute value, which must contain a simple pattern expression. The element may contain any AIML template elements.

Returns:
Returns boolean true if this is a value only list item otherwise it will return false.
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

virtual void setAttribute const StringPimpl name,
const StringPimpl value
throw (InternalProgrammerErrorException &) [virtual]
 

Sets its attribute of "name" and "value".

Parameters:
name The name of the AIML XML attribute
value The value of the AIML XML attribute
Exceptions:
InternalProgrammerErrorException is thrown only if the error is so grave that the entire AIML engine has to be shut down.

Reimplemented from Tag.


Member Data Documentation

shared_ptr<LiImpl> m_pimpl [private]
 

The private implementation in which you cannot get access to.

This shared_ptr holds the private methods and private member variables of this class. This makes ABI (Application Binary Interface) more resilient to change. See the private implementation idiom on the internet for more information about this.

Reimplemented from InnerTemplateListImpl.


The documentation for this class was generated from the following file:
Generated on Thu Sep 7 22:05:53 2006 for RebeccaAIML by  doxygen 1.4.5