IBM Agent Building Environment Developer's Toolkit

Level 6   COMPONENTS AND ADAPTER REFERENCE IBM Agent Building Environment Developer's Toolkit
June, 1997

IBM Intelligent Agent Center of Competence
home page: http://www.networking.ibm.com/iag/iaghome.html
e-mail address:iagent@us.ibm.com.

This toolkit is provided for experimentation and without any formal support. However, you are encouraged to send feedback or report bugs to our e-mail id: iagent@us.ibm.com.

Level 5, June, 1997

This documentation applies to the IBM Agent Building Environment Developer's Toolkit, Level 5.

© Copyright International Business Machines Corporation 1997. All rights reserved.
Note to U.S. Government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule contract with IBM Corp.


Table of Contents

Chapter 1. Building ABE-Related Components

  • Building ABE Components with C++
  • General Guidelines
  • Using ABE Header Files
  • Always Build Multithreaded Executables
  • Use the DLL Version of Run-time Libraries
  • Using ABE Libraries
  • Using IBM VisualAge C++ on Windows 95/NT
  • Compiling Your Code
  • Linking Your Code
  • ABE Import Libraries
  • A Sample Makefile
  • For More Information
  • Using Microsoft Visual C++ on Windows 95/NT
  • Compiling Your Code
  • Linking Your Code
  • ABE Import Libraries
  • A Sample Makefile
  • For More Information
  • Using Borland C++ on Windows 95/NT
  • Compiling Your Code
  • Linking Your Code
  • As an EXE
  • ABE Import Libraries
  • A Sample Makefile
  • Using IBM VisualAge C++ on OS/2
  • Compiling Your Code
  • Linking Your Code
  • ABE Import Libraries
  • A Sample Makefile
  • For More Information
  • Using IBM C Set++ on AIX
  • ABE Shared Libraries
  • A Sample Makefile
  • Building ABE Components with Java
  • Chapter 2. Agent Reference

  • Compiling and Linking with IAAgent and Associated Classes
  • Class IAAgent
  • Header File
  • Constructors
  • Service Functions
  • addAdapter
  • addEngine
  • addLibrary
  • connect
  • getEventsCompleted
  • loadConductSet
  • reset
  • start
  • stop
  • unloadConductSet
  • dbgInfo
  • Callback Functions
  • handleAlert
  • Class IAAdapterHandle
  • Header File
  • Constructors
  • IAAdapterHandle
  • Member Functions
  • == (operator overload)
  • != (operator overload)
  • isValid
  • Class IAEngineHandle
  • Header File
  • Constructors
  • IAEngineHandle
  • Member Functions
  • == (operator overload)
  • != (operator overload)
  • Class IALibraryHandle
  • Header File
  • Constructors
  • IALibraryHandle
  • Member Functions
  • == (operator overload)
  • != (operator overload)
  • isValid
  • Chapter 3. Adapter Reference Material

  • Compiling and Linking with Adapter Classes
  • Class IAAdapter
  • Header File
  • Constructors
  • Service Functions
  • notify
  • registerProcedure
  • generateAlert
  • Adapter Control Callback Functions
  • identify
  • reset
  • restart
  • shutdown
  • start
  • stop
  • quiesce
  • Event-Related Callback Functions
  • eventComplete
  • testCondition
  • answerQuery
  • performAction
  • Factory Functions
  • newAdapter
  • Class IAAtom
  • Header File
  • Constructors
  • IAAtom
  • IAAtom
  • Member Functions
  • ~IAAtom
  • == (operator overload)
  • != (operator overload)
  • operator <
  • (conversion) operator const char *()
  • setPredicate
  • setKIF
  • setTerms
  • replaceSymbolLogicalVariable
  • replaceLogicalVariable
  • replaceLogicalVariable
  • replaceLogicalVariable
  • getKif
  • addTerm
  • addTerm
  • addTerm
  • addSymbolTerm
  • addLogicalVariable
  • getNumberOfTerms
  • getTermType
  • isFact
  • isLogicalVariable
  • isLogicalVariable
  • getSymbolTerm
  • getStringTerm
  • getIntegerTerm
  • getRealTerm
  • getPredicate
  • dbgInfo
  • Class IAError
  • Header File
  • Constructors
  • IAError(default constructor)
  • IAError
  • IAError
  • IAError
  • IAError
  • Copy constructor
  • Member Functions
  • Destructor
  • =(operator overload)
  • msgnumber
  • errormsg
  • isOk
  • !(operator override)
  • not
  • set
  • set
  • set
  • set
  • dbgInfo
  • Class IAEventHeader
  • Header File
  • Constructors
  • IAEventHeader (default constructor)
  • Copy constructor
  • Member Functions
  • Destructor
  • =(operator overload)
  • getId
  • getDomain
  • getSelector
  • getType
  • eventNumber
  • getTime
  • setType
  • setSelector
  • dbgInfo
  • Class IAFactSet
  • Header File
  • Constructors
  • IAFactSet
  • IAFactSet
  • Member Functions
  • ~IAFactSet
  • operator =
  • add
  • add
  • clear
  • size
  • first
  • next
  • dbgInfo
  • Class IATriggerEvent
  • Header File
  • Constructors
  • IATriggerEvent (default constructor)
  • Copy constructor
  • Member Functions
  • Destructor
  • =(operator overload)
  • getHeader
  • getFacts
  • isValid
  • setFactSet
  • setType
  • dbgInfo
  • Class IAUniqueId
  • Header File
  • Constructors
  • IAUniqueId
  • Copy constructor
  • Member Functions
  • ~IAUniqueId
  • = (operator overload)
  • == (operator overload)
  • != (operator overload)
  • < (operator overload)
  • hashCode
  • generate
  • asString
  • isValid
  • dbgInfo
  • Chapter 4. Library Reference

  • Compiling and Linking Your Application with IALibrary
  • Class IALibrary
  • Constructors
  • IALibrary
  • Basic Member Functions
  • attachImplementation
  • getMap
  • getType
  • getDllName
  • getLibName
  • getTop
  • getConductSet
  • getInferenceSet
  • ~IALibrary
  • Factory Member Functions
  • new_IALibInferenceCollector
  • new_IALibInferenceContentsElement
  • new_IALibInferenceRuleSet
  • new_IALibInferenceRule
  • new_IALibInferenceLTFactSet
  • new_IALibInferenceLTFact
  • new_IALibLogRecordSet
  • new_IALibLogRecord
  • delete_IALibInferenceCollector
  • delete_IALibInferenceContentsElement
  • delete_IALibInferenceRuleSet
  • delete_IALibInferenceRule
  • delete_IALibInferenceLTFactSet
  • delete_IALibInferenceLTFact
  • delete_IALibLogRecordSet
  • delete_IALibLogRecord
  • Class IALibInferenceCollector
  • Constructors
  • IALibInferenceCollector
  • IALibInferenceCollector
  • Member Functions
  • extractName
  • setMetadataName
  • extractVersion
  • extractMetadataName
  • extractMetadata
  • setMetadata
  • size
  • extractLibraryPtr
  • del
  • delMetadata
  • setCursorElementScope
  • find
  • find
  • firstElement
  • firstElement
  • lastElement
  • lastElement
  • nextElement
  • nextElement
  • previousElement
  • previousElement
  • get
  • getWithoutMetadata
  • put
  • putWithoutMetadata
  • ~IALibInferenceCollector
  • Class IALibInferenceContentsElement
  • Constructors
  • IALibInferenceContentsElement
  • IALibLogRecord
  • Member Functions
  • extractElementName
  • extractType ()
  • extractMetadataName
  • ~IALibInferenceContentsElement
  • Class IALibInferenceRuleSet
  • Constructors
  • IALibInferenceRuleSet
  • Member Functions
  • extractName
  • extractID
  • extractVersion
  • setMetadataName
  • extractMetadataName
  • setMetadata
  • extractMetadata
  • setRulesMetadataName
  • extractRulesMetadataName
  • size
  • activate
  • inactivate
  • isActive
  • del
  • delMetadata
  • delRulesMetadata
  • deleteRule
  • addRule
  • addRuleAsNext
  • addRuleAsPrevious
  • updateRule
  • find
  • find
  • firstRule
  • firstRule
  • lastRule
  • lastRule
  • nextRule
  • nextRule
  • previousRule
  • previousRule
  • currentRule
  • currentRule
  • get
  • getWithoutMetadata
  • put
  • putWithoutMetadata
  • ~IALibInferenceRuleSet
  • Class IALibInferenceRule
  • Constructors
  • IALibInferenceRule
  • IALibInferenceRule
  • Member Functions
  • setName
  • extractName
  • setID
  • extractID
  • setMetadata
  • extractMetadata
  • activate
  • inactivate
  • isActive
  • isDeleted
  • setKif
  • extractKif
  • del
  • undelete
  • validate
  • ~IALibInferenceRule
  • Class IALibInferenceLTFactSet
  • Constructors
  • IALibInferenceLTFactSet
  • Member Functions
  • extractName
  • extractID
  • extractVersion
  • setMetadataName
  • extractMetadataName
  • setMetadata
  • extractMetadata
  • setLTFactsMetadataName
  • extractLTFactsMetadataName
  • size
  • activate
  • inactivate
  • isActive
  • del
  • delMetadata
  • delLTFactsMetadata
  • deleteLTFact
  • addLTFact
  • addLTFactAsNext
  • addLTFactAsPrevious
  • updateLTFact
  • find
  • find
  • firstLTFact
  • firstLTFact
  • lastLTFact
  • lastLTFact
  • nextLTFact
  • nextLTFact
  • previousLTFact
  • previousLTFact
  • currentLTFact
  • currentLTFact
  • get
  • getWithoutMetadata
  • put
  • putWithoutMetadata
  • ~IALibInferenceLTFactSet
  • Class IALibInferenceLTFact
  • Constructors
  • IALibInferenceLTFact
  • IALibInferenceLTFact
  • Member Functions
  • setName
  • extractName
  • setID
  • extractID
  • setMetadata
  • extractMetadata
  • activate
  • inactivate
  • isActive
  • isDeleted
  • setKif
  • extractKif
  • del
  • undelete
  • validate
  • ~IALibInferenceLTFact
  • Class IALibLogRecordSet
  • Constructors
  • IALibLogRecordSet
  • Member Functions
  • setLevel
  • extractLevel
  • extractCacheSize
  • extractLogSize
  • extractCurrentLogSize
  • extractName
  • setMetadataName
  • setMetadata
  • setMetadata
  • extractVersion
  • extractMetadataSize
  • extractMetadataName
  • extractMetadata
  • extractMetadata
  • del
  • clear
  • addRecord
  • getRecord
  • get
  • get
  • put
  • putMetadata()
  • ~IALibLogRecordSet()
  • Class IALibLogRecord
  • Constructors
  • IALibLogRecord
  • IALibLogRecord
  • Member Functions
  • setType
  • extractType
  • setCategory
  • extractCategory
  • setOriginator
  • extractOriginator
  • extractDate
  • extractTime
  • setSourceId
  • extractSourceId
  • setMessageId
  • extractMessageId
  • extractKeyPosition
  • addToken
  • getToken
  • ~IALibLogRecord()
  • Chapter 5. Adapters Provided by ABE

  • File Adapter Reference
  • Trigger Events
  • FileChanged
  • FileCreated
  • FileDeleted
  • FileNotFound
  • CopyFailed
  • MoveFailed
  • DeleteFailed
  • ExecuteFailed
  • FileError
  • AppendFailed
  • DirectoryEmpty
  • DirectoryError
  • Sensors
  • ExistFile
  • Effectors
  • CheckFile
  • CheckDirectory
  • CopyFile
  • MoveFile
  • DeleteFile
  • ExecuteFile
  • AppendFile
  • Sample Rules
  • HTTP Adapter Reference
  • Trigger Events
  • webPageArrived
  • webPageChanged
  • addFailed
  • Sensors
  • GetHTTPStream
  • GetHTTPContent
  • TagValue
  • Effectors
  • SetHTTPProxy
  • SetHTTPSocks
  • RequestHTTPWebPage
  • AddURLtoMonitorList
  • AddURLtoMonitorList2
  • RemoveURLfromMonitorList
  • CheckMonitoredPagesForChanges
  • Sample Rules
  • NNTP Adapter Reference
  • Trigger Events
  • NEW_NEWS
  • Sensors
  • KeyInBody
  • KeyInHeader
  • IsFrom
  • IsFromEmailAddress
  • InGroup
  • IsUuencoded
  • IsMime
  • LinesInRange
  • TextIs
  • Effectors
  • SelectHistoryFile
  • AddNewsgroup
  • GetNews
  • Show
  • Sample Rules
  • Time Adapter Reference
  • Trigger Events
  • Alarm
  • Sensors
  • timeAfter
  • timeBefore
  • currentTimeAfter
  • currentTimeBefore
  • timeBetween
  • currentTimeBetween
  • timeEqual
  • timeNotEqual -
  • currentTimeEqual
  • currentTimeNotEqual
  • isCurrentDay
  • isWeekend
  • isCurrentWeekday
  • isCurrentWeekend
  • dateAndTime
  • currentDate
  • currentTime
  • dayOfWeek
  • addTimeInterval
  • determineTimeInterval
  • Effectors
  • turnOffAlarm
  • setAlarmAt
  • setIntervalAlarm
  • setStartBoundedIntervalAlarm
  • setEndBoundedIntervalAlarm
  • setBoundedIntervalAlarm
  • setIntervalAlarmRandomStart
  • setRandomStartBoundedIntervalAlarm
  • setRandomBoundedIntervalAlarm
  • setDailyAlarm
  • setSpecificDailyAlarm
  • setPersistentFileName
  • setDuplicateHandling
  • setOverdueAlarmPresentationCriteria
  • setPersistentCategories
  • reset
  • checkPoint
  • Sample rules
  • Utility Adapter Reference
  • Sensors
  • CompareI2I
  • CompareI2S
  • CompareS2I
  • CompareS2S
  • CompareR2R
  • CompareR2I
  • CompareI2R
  • MathI2I
  • MathS2I
  • MathI2S
  • MathS2S
  • MathR2R
  • MathR2I
  • MathI2R
  • ConvertI2S
  • ConvertS2I
  • ConvertR2S
  • ConvertS2R
  • StringAppend
  • StringAppendMany
  • Effector
  • StringPrint
  • Sample rules
  • Mail (Sample) Adapter Reference
  • Trigger Events
  • Sensors
  • Effectors
  • EMailFromAddressIs
  • EMailRelayHostIs
  • EMail
  • EMailWithSubject
  • Sample Rules
  • Stock (Sample) Adapter Reference
  • Trigger Events
  • StockPriceEvent
  • Sensors
  • StockCompare
  • IntegerCompare
  • GetStockEventCount
  • Effectors
  • StockAdapterMonitorClass
  • StockAdapterParserClass
  • StockAdapterProxy
  • StockAdapterShow
  • StockAdapterURL
  • StockMonitor
  • Sample rules



  • [ Top of Page | Next Page ]