Class TPositionUpdateOptionsBase

class TPositionUpdateOptionsBase : public TPositionClassTypeBase;

Description

The base class for classes storing position update options

Derivation

• TPositionClassTypeBase - The base class for classes used to store position information

• TPositionUpdateOptionsBase - The base class for classes storing position update options

Members

Defined in TPositionUpdateOptionsBase:

• MaxUpdateAge()constReturns the maximum update age
• SetMaxUpdateAge(TTimeIntervalMicroSeconds)sets the maximum update age
• SetUpdateInterval(TTimeIntervalMicroSeconds)Sets update interval
• SetUpdateTimeOut(TTimeIntervalMicroSeconds)Sets the update timeout
• TPositionUpdateOptionsBase()Default constructor for TPositionUpdateOptionsBase
• TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds,TTimeIntervalMicroSeconds,TTimeIntervalMicroSeconds)Constructor for TPositionUpdateOptionsBase. All parameters except aInterval have...
• UpdateInterval()constReturns the update interval
• UpdateTimeOut()constReturns the update timeout
• iMaxUpdateAgeThe maximum update age
• iUpdateIntervalThe update interval
• iUpdateTimeOutThe update timeout

Inherited from TPositionClassTypeBase:

• PositionClassSize()constPositionClassSize
• PositionClassType()constPositionClassTypeType
• iPosClassSizeThe size of the derived class
• iPosClassTypeThe type of the derived class

protected: IMPORT_C TPositionUpdateOptionsBase();

Description

Default constructor for TPositionUpdateOptionsBase

protected: IMPORT_C TPositionUpdateOptionsBase(TTimeIntervalMicroSeconds aInterval, TTimeIntervalMicroSeconds aTimeOut=TTimeIntervalMicroSeconds(0), TTimeIntervalMicroSeconds aMaxAge=TTimeIntervalMicroSeconds(0));

Description

Constructor for TPositionUpdateOptionsBase. All parameters except aInterval have default values.

Parameters

Panic codes

IMPORT_C void SetUpdateInterval(TTimeIntervalMicroSeconds aInterval);

Description

Sets update interval

Parameters

Panic codes

IMPORT_C void SetUpdateTimeOut(TTimeIntervalMicroSeconds aTimeOut);

Description

Sets the update timeout

Parameters

Panic codes

IMPORT_C void SetMaxUpdateAge(TTimeIntervalMicroSeconds aMaxAge);

Description

sets the maximum update age

Parameters

Panic codes

IMPORT_C TTimeIntervalMicroSeconds UpdateInterval() const;

Description

Returns the update interval

Return value

IMPORT_C TTimeIntervalMicroSeconds UpdateTimeOut() const;

Description

Returns the update timeout

Return value

IMPORT_C TTimeIntervalMicroSeconds MaxUpdateAge() const;

Description

Returns the maximum update age

Return value

protected: TTimeIntervalMicroSeconds iUpdateInterval;

Description

The update interval

protected: TTimeIntervalMicroSeconds iUpdateTimeOut;

Description

The update timeout

protected: TTimeIntervalMicroSeconds iMaxUpdateAge;

Description

The maximum update age