PreEmptive Analytics Win32 Client
 All Classes Files Functions Variables Typedefs Macros
Public Member Functions | List of all members
BinaryInfo Class Reference

Describes a software module and call site. More...

Public Member Functions

DLL_PACLIENT BinaryInfo ()
 Create an empty BinaryInfo instance. More...
 
DLL_PACLIENT ~BinaryInfo ()
 Dispose of a BinaryInfo instance. More...
 
DLL_PACLIENT const wchar_t * GetClassName () const
 Get the name of the invoking class. More...
 
DLL_PACLIENT const wchar_t * GetID () const
 Get the identifier GUID for the module. More...
 
DLL_PACLIENT const wchar_t * GetMethodName () const
 Get the name of the invoking method or function. More...
 
DLL_PACLIENT unsigned long long GetModifiedDate () const
 Get the modification date of the module. More...
 
DLL_PACLIENT const wchar_t * GetModifiedDateString () const
 Get the modification date of the module as a string. More...
 
DLL_PACLIENT const wchar_t * GetName () const
 Get the name for the module. More...
 
DLL_PACLIENT const wchar_t * GetVersion () const
 Get the version string for the module. More...
 
DLL_PACLIENT void SetClassName (const wchar_t *className)
 Set the class name of an invoking method. More...
 
DLL_PACLIENT void SetID (const wchar_t *id)
 Sets the ID, a GUID, used to identify the module. More...
 
DLL_PACLIENT void SetMethodName (const wchar_t *methodName)
 Set the method name of an invoking method. More...
 
DLL_PACLIENT void SetModifiedDate (unsigned long long modifiedDate)
 Set the modification time for the module. More...
 
DLL_PACLIENT void SetName (const wchar_t *name)
 Set the name used to identify the module. More...
 
DLL_PACLIENT void SetVersion (const wchar_t *version)
 Set the version of the module. More...
 

Detailed Description

Describes a software module and call site.

A BinaryInfo instance is used to pass additional information to the server about the software module that is generating a message.
Each module is described by a ID that is a string representation of a GUID and a corresponding name. It can also include version information and a time stamp for the date of the module.
Object oriented languages can also specify the call site for the generated message by providing the class and method name.
All values are optional.

Constructor & Destructor Documentation

DLL_PACLIENT BinaryInfo::BinaryInfo ( )

Create an empty BinaryInfo instance.

Creates a new instance will default values. All strings are blank and numeric values are zero.
DLL_PACLIENT BinaryInfo::~BinaryInfo ( )

Dispose of a BinaryInfo instance.

Deletes the prevously created instance.

Member Function Documentation

DLL_PACLIENT const wchar_t* BinaryInfo::GetClassName ( ) const

Get the name of the invoking class.

Returns
the name of the invoking class.
See Also
SetClassName()
DLL_PACLIENT const wchar_t* BinaryInfo::GetID ( ) const

Get the identifier GUID for the module.

Returns
the GUID for the module.
See Also
SetID()
DLL_PACLIENT const wchar_t* BinaryInfo::GetMethodName ( ) const

Get the name of the invoking method or function.

Returns
the name of the invoking method or function.
See Also
SetMethodName()
DLL_PACLIENT unsigned long long BinaryInfo::GetModifiedDate ( ) const

Get the modification date of the module.

Returns
number of milliseconds since midnight Jan 1, 1970 using the Gregorian calendar and UTC. Zero is used to indicate the date is not known.
See Also
SetModifiedDate()
DLL_PACLIENT const wchar_t* BinaryInfo::GetModifiedDateString ( ) const

Get the modification date of the module as a string.

Returns
the modification date of the module as a string or an empty string if the time was zero.
See Also
SetModifiedDate()
DLL_PACLIENT const wchar_t* BinaryInfo::GetName ( ) const

Get the name for the module.

Returns
the name for the module
See Also
SetName()
DLL_PACLIENT const wchar_t* BinaryInfo::GetVersion ( ) const

Get the version string for the module.

Returns
the version string for the module.
See Also
SetVersion()
DLL_PACLIENT void BinaryInfo::SetClassName ( const wchar_t *  className)

Set the class name of an invoking method.

Object oriented languages can pass in the name of the class invoking the PAClient method. This value is optional.
Parameters
classNamea class name in the source language's format. className is free-form.
See Also
GetClassName()
DLL_PACLIENT void BinaryInfo::SetID ( const wchar_t *  id)

Sets the ID, a GUID, used to identify the module.

This value is optional.
Parameters
idthe GUID used to identify the module. If not a valid GUID then the value is ignored.
See Also
GetID()
DLL_PACLIENT void BinaryInfo::SetMethodName ( const wchar_t *  methodName)

Set the method name of an invoking method.

Object oriented languages can pass in the name of the method invoking the PAClient method. Non-object oriented language can use this to pass in the name of the invoking function. This value is optional.
Parameters
methodNamea method or function name in the source language's format. methodName is free-form.
See Also
GetMethodName()
DLL_PACLIENT void BinaryInfo::SetModifiedDate ( unsigned long long  modifiedDate)

Set the modification time for the module.

If the modification time of the module is known it can be sent to the server. The modification time is based on the number of milliseconds since midnight of Jan 1, 1970. This value is optional.
Parameters
modifiedDatenumber of milliseconds since midnight Jan 1, 1970 using the Gregorian calendar and UTC. Zero is used to indicate the date is not known.
See Also
GetModifiedDate()
GetModifiedDateString()
DLL_PACLIENT void BinaryInfo::SetName ( const wchar_t *  name)

Set the name used to identify the module.

This is a human readable identifier for the module such as "Logging.DLL" or "libprint.so". Do not include a version portion here: use SetVersion(). This value is optional.
Parameters
namea name for the module. name is free-form.
See Also
GetName()
DLL_PACLIENT void BinaryInfo::SetVersion ( const wchar_t *  version)

Set the version of the module.

If the module's version is known it can be sent to the server. This is a free-form value, but a dotted version string is recommended. This value is optional.
Parameters
versiona version string. version is free-form.
See Also
GetVersion()