CPKIFAccuracy Class Reference

#include <Accuracy.h>

Collaboration diagram for CPKIFAccuracy:

[legend]

List of all members.

---

Detailed Description

The CPKIFAccuracy class provides an interface to RFC 3161 Accuracy objects, which are defined as follows:

Accuracy ::= SEQUENCE 
{
	seconds INTEGER OPTIONAL, 
	millis [0] INTEGER (1..999) OPTIONAL, 
	micros [1] INTEGER (1..999) OPTIONAL 
}

Accuracy objects appear in TSTInfo structures to represent the time deviation around the UTC time contained in the GeneralizedTime field.

TSP-enforcing: No

Definition at line 35 of file Accuracy.h.

Public Member Functions
	CPKIFAccuracy ()
	CPKIFAccuracy (const CPKIFBufferPtr &accuracyBuf)
	~CPKIFAccuracy ()
int	GetSeconds () const
void	SetSeconds (int seconds)
int	GetMillis () const
void	SetMillis (int millis)
int	GetMicros () const
void	SetMicros (int micros)
bool	GetSecondsPresent ()
bool	GetMillisPresent ()
bool	GetMicrosPresent ()

---

Constructor & Destructor Documentation

CPKIFAccuracy::CPKIFAccuracy

(

)

Interface: External

This function creates and initializes CPKIFAccuracy object. By default, all properties are set to be absent.

Returns:

None

Definition at line 86 of file Accuracy.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

CPKIFAccuracy::CPKIFAccuracy

(

const CPKIFBufferPtr &

accuracyBuf

)

Interface: External

his function creates and initializes CPKIFAccuracy object. It used data from PKIFTSPAccuracy parameter to populate fields

Returns:

None

Parameters:

accuracyBuf

[in] Reference to a PKIFTSPAccuracy structure containing information used to populate a new instance of CPKIFAccuracy

Definition at line 104 of file Accuracy.cpp.

References CACASNWRAPPER_CREATE, LOG_STRING_DEBUG, SetMicros(), SetMillis(), SetSeconds(), and TOOLKIT_TSP_ASN.

CPKIFAccuracy::~CPKIFAccuracy

(

)

Interface: External

This function destroys CPKIFAccuracy objects.

Returns:

None

Definition at line 141 of file Accuracy.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.

---

Member Function Documentation

int CPKIFAccuracy::GetSeconds

(

)

const

Interface: External

These functions are used to get the seconds value carried by an Accuracy object.

Returns:

The GetSeconds function returns the integer value of the Seconds property. The value has no meaning unless GetSecondsPresent returns true.

Definition at line 193 of file Accuracy.cpp.

void CPKIFAccuracy::SetSeconds

(

int

seconds

)

Interface: External

These functions are used to set the seconds value carried by an Accuracy object.

Returns:

None

Parameters:

seconds

[in] Integer value representing the number of seconds to include in an Accuracy object

Definition at line 204 of file Accuracy.cpp.

References COMMON_INVALID_INPUT, and TOOLKIT_TSP_ASN.

Referenced by CPKIFAccuracy().

int CPKIFAccuracy::GetMillis

(

)

const

Interface: External

This function is used to get the milliseconds value carried by an Accuracy object. The value passed to SetMillis must be between 1 and 999.

Returns:

The GetSeconds function returns the integer value of the Millis property. The value has no meaning unless GetMillisPresent returns true.

Definition at line 222 of file Accuracy.cpp.

void CPKIFAccuracy::SetMillis

(

int

millis

)

Interface: External

This function is used to set the milliseconds value carried by an Accuracy object. The value passed to SetMillis must be between 1 and 999.

Returns:

None

Parameters:

millis

[in] Integer value representing the number of milliseconds to include in an Accuracy object

Definition at line 234 of file Accuracy.cpp.

References COMMON_INVALID_INPUT, and TOOLKIT_TSP_ASN.

Referenced by CPKIFAccuracy().

int CPKIFAccuracy::GetMicros

(

)

const

Interface: External

This function is used to get the milliseconds value carried by an Accuracy object. The value passed to SetMicros must be between 1 and 999.

Returns:

The GetMicros function returns the integer value of the Micros property. The value has no meaning unless GetMicrosPresent returns true.

Definition at line 252 of file Accuracy.cpp.

void CPKIFAccuracy::SetMicros

(

int

micros

)

Interface: External

This function is used to set the milliseconds value carried by an Accuracy object. The value passed to SetMicros must be between 1 and 999.

Returns:

None

Parameters:

micros

[in] Integer value representing the number of microseconds to include in an Accuracy object

Definition at line 264 of file Accuracy.cpp.

References COMMON_INVALID_INPUT, and TOOLKIT_TSP_ASN.

Referenced by CPKIFAccuracy().

bool CPKIFAccuracy::GetSecondsPresent

(

)

Interface: External

This function is used to get the Boolean value indicating the presence of a Seconds value in a CPKIFAccuracy object.

Returns:

Boolean value indicating the presence of a Seconds value in a CPKIFAccuracy object

Definition at line 156 of file Accuracy.cpp.

bool CPKIFAccuracy::GetMillisPresent

(

)

Interface: External

This function is used to get the Boolean value indicating the presence of a Millis value in a CPKIFAccuracy object.

Returns:

Boolean value indicating the presence of a Millis value in a CPKIFAccuracy object.

Definition at line 168 of file Accuracy.cpp.

bool CPKIFAccuracy::GetMicrosPresent

(

)

Interface: External

This function is used to get the Boolean value indicating the presence of a Micros value in a CPKIFAccuracy object.

Returns:

None

Definition at line 180 of file Accuracy.cpp.

---

The documentation for this class was generated from the following files:

• Accuracy.h
• Accuracy.cpp