Class: TSupportSchedule

Declaration: Scheduling.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TThreadSchedule

Inherited By:

None.

Purpose:

Defines a schedule for tasks having moderate CPU usage but not critical on timely response. Typically, background tasks run for a long time.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSupportSchedule::TSupportSchedule

TSupportSchedule ()
TSupportSchedule (const TSupportSchedule & aSupportSchedule)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TSupportSchedule & aSupportSchedule -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSupportSchedule::~TSupportSchedule

virtual ~ TSupportSchedule ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSupportSchedule::operator=

TSupportSchedule & operator =(const TSupportSchedule & aSupportSchedule)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSupportSchedule & aSupportSchedule -The right-hand side object of the assignment operation.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSupportSchedule::operator<<=

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if a version mismatch occurs.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSupportSchedule::operator>>=

TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSupportSchedule::GetPriority

virtual AbsolutePriority GetPriority () const

Interface Category:

API.

Purpose:

Gets the priority associated with this object.

Calling Context:

Called to get the priority of a TSupportSchedule class object.

Parameters:

Takes no parameters.

Return Value:

The priority value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is for Taligent internal use only.

Member Function: TSupportSchedule::GetPolicy

virtual SchedulingPolicy GetPolicy () const

Interface Category:

API.

Purpose:

Gets the policy value associated with this class object.

Calling Context:

Called to get the policy value associated with this class object.

Parameters:

Takes no parameters.

Return Value:

Returns the policy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is for Taligent internal use only.

Member Function: TSupportSchedule::GetMaximumPriority

virtual AbsolutePriority GetMaximumPriority () const

Interface Category:

API.

Purpose:

Gets the maximum priority upper limit for this class object.

Calling Context:

Called to get the upper limit on the priority for this class object.

Parameters:

Takes no parameters.

Return Value:

Returns a priority value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is for Taligent internal use only.

Member Function: TSupportSchedule::GetMinimumPriority

virtual AbsolutePriority GetMinimumPriority () const

Interface Category:

API.

Purpose:

Gets the minimum priority lower limit for this class object.

Calling Context:

Called to get the lower limit on the priority for this class object.

Parameters:

Takes no parameters.

Return Value:

Returns a priority value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is for Taligent internal use only.

Member Function: TSupportSchedule::SetPriority

virtual void SetPriority (const AbsolutePriority thePriority)

Interface Category:

API.

Purpose:

Sets the priority value for this class object.

Calling Context:

Called to set a priority value for this object.

Parameters:

const AbsolutePriority thePriority -The priority to be set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is for Taligent internal use only. Note that no exceptions are thrown even if incorrect priority values are specified, thus, due care must be taken while using this member function.

Click the icon to mail questions or corrections about this material to Taligent personnel.