Main Table of Contents

Table of Contents

class PtWatchSpec
PtWatchSpec: class summary
PtWatchSpec::PtWatchSpec()
PtWatchSpec::~PtWatchSpec()
PtWatchSpec::Decode()
PtWatchSpec::DeepMode()
PtWatchSpec::Encode()
PtWatchSpec::Mode()
PtWatchSpec::Decode()
PtWatchSpec::OriginId()
PtWatchSpec::Target()
PtWatchSpec::operator = ()
PtWatchSpec::operator != ()

class PtWatchSpec


Intro
PtWatchSpec: class summary
PtWatchSpec::PtWatchSpec()
PtWatchSpec::~PtWatchSpec()
PtWatchSpec::Decode()
PtWatchSpec::DeepMode()
PtWatchSpec::Encode()
PtWatchSpec::Mode()
PtWatchSpec::Decode()
PtWatchSpec::OriginId()
PtWatchSpec::Target()
PtWatchSpec::operator = ()
PtWatchSpec::operator != ()

A PtWatchSpec is a Watch specification; that is, it contains the parameters used to specify a Watch. All methods that set watches or free watches take a PtWatchSpec as a parameter.

Please see the chapter "Event Handling" for a complete set of the methods which use a PtWatchSpec and for examples of setting and freeing watches. Watch modes, depth modes, and method references are also discussed in the chapter "Event Handling."

PtWatchSpec: class summary


Intro

Files to include Class declaration Base class
poet.hxx ptmode.hxx none

Member functions:

constructor PtWatchSpec();
destructor ~PtWatchSpec();
Decode void Decode(PtWatchEncode);
DeepMode inline PtDepthMode& DeepMode();
Encode int Encode(PtWatchEncode& );
Mode inline PtWatchMode& Mode();
OriginId inline unsigned long & OriginId();
Target inline PtMethodRef& Target();
operator = PtWatchSpec& operator = (PtWatchSpec& );
operator != int operator != (PtWatchSpec& );

PtWatchSpec::PtWatchSpec()


Intro

Declaration:

PtWatchSpec::PtWatchSpec() PtWatchSpec::PtWatchSpec(PtWatchSpec&) PtWatchSpec::PtWatchSpec(PtWatchMode,PtDepthMode) PtWatchSpec::PtWatchSpec(PtWatchMode,PtDepthMode,PtMethodRef&)

Description:

Constructors. The WatchSpec created contains the information specified by the parameters. If no parameters are specified then the WatchSpec specifies nothing.

PtWatchSpec::~PtWatchSpec()


Intro

Declaration:

PtWatchSpec::~PtWatchSpec()

Description:

Destructor.

PtWatchSpec::Decode()


Intro

Declaration:

int PtWatchSpec::Decode(PtWatchEncode)

Description:

This is an internal function which is used by POET. Do not use it in your programs.

PtWatchSpec::DeepMode()


Intro

Declaration:

PtDepthMode& PtWatchSpec::DeepMode()

Description:

Returns the depth mode for the PtWatchSpec.

PtWatchSpec::Encode()


Intro

Declaration:

int PtWatchSpec::Encode(PtWatchEncode& )

Description:

This is an internal function which is used by POET. Do not use it in your programs.

PtWatchSpec::Mode()


Intro

Declaration:

PtWatchMode& PtWatchSpec::Mode()

Description:

Returns the watch mode for the PtWatchSpec.

PtWatchSpec::Decode()


Intro

Declaration:

PtDepthMode& PtWatchSpec::Decode()

Description:

This is an internal function which is used by POET. Do not use it in your programs.

PtWatchSpec::OriginId()


Intro

Declaration:

inline unsigned long& PtWatchSpec::OriginId()

Description:

This is an internal function which is used by POET. Do not use it in your programs.

PtWatchSpec::Target()


Intro

Declaration:

PtMethodRef& PtWatchSpec::Target()

Description:

Returns the method reference for the PtWatchSpec.

PtWatchSpec::operator = ()


Intro

Declarations:

PtWatchSpec& PtWatchSpec::operator = (PtWatchSpec& )

PtWatchSpec& PtWatchSpec::operator = (PtWatchMode mode)

PtWatchSpec& PtWatchSpec::operator = (PtDepthMode deep)

PtWatchSpec& PtWatchSpec::operator = (PtMethodRef& )

Each of these is described separately below.

Declaration:

PtWatchSpec& PtWatchSpec::operator = (PtWatchSpec& )

Description:

Assignment operator. Copies one PtWatchSpec to another.

Example:

PtWatchSpec WatchSpec = AnotherWatchSpec;

Declaration:

PtWatchSpec& PtWatchSpec::operator = (PtWatchMode mode)

Description:

Assignment operator. Sets the watch mode for a PtWatchSpec.

Example:

PtWatchSpec WatchSpec = WatchMode;

Declaration:

PtWatchSpec& PtWatchSpec::operator = (PtDepthMode deep)

Description:

Assignment operator. Sets the depth mode for a PtWatchSpec.

Example:

PtWatchSpec WatchSpec = DepthMode;

Declaration:

PtWatchSpec& PtWatchSpec::operator = (PtMethodRef& )

Description:

Assignment operator. Sets the method reference for a PtWatchSpec.

Example:

PtWatchSpec WatchSpec = MethodRef;

PtWatchSpec::operator != ()


Intro

Declaration:

int PtWatchSpec::operator != (PtWatchSpec& )

Description:

Comparison operator. Determines if two WatchSpecs are the same. int cmp = FirstWatchSpec != SecondWatchSpec;

Returns:

<0 FirstWatchSpec < SecondWatchSpec 0 FirstWatchSpec == SecondWatchSpec >0 FirstWatchSpec > SecondWatchSpec

Copyright (c) 1996 POET Software, Inc. All rights reserved. Reproduction in whole or in part in any form or medium without the express permission of POET Software, Inc. is prohibited.