trek_data_support_functions.h File Reference

A series of functions to handle memory creation and removal. More...

#include "trek_data_defines.h"
#include "counter_dependency.h"
#include "delimited_parameter_collection.h"
#include "enumerator.h"
#include "expected_state_alarm.h"
#include "limit_alarm.h"
#include "packet.h"
#include "parameter.h"
#include "parameter_collection.h"
#include "parameter_status.h"
#include "polynomial_calibrator.h"
#include "range_enumerator.h"
#include "spline_calibrator.h"
#include "string_array.h"
#include "trek_time.h"
#include "random_packet_collection.h"

Functions
CounterDependency EXPORT_THIS_DATA_API_CLASS *	trek::CreateCounterDependency ()
	Creates an CounterDependency object. More...
Enumerator EXPORT_THIS_DATA_API_CLASS *	trek::CreateEnumerator ()
	Creates an Enumerator object. More...
ExpectedStateAlarm EXPORT_THIS_DATA_API_CLASS *	trek::CreateExpectedStateAlarm ()
	Creates a ExpectedStateAlarm object. More...
LimitAlarm EXPORT_THIS_DATA_API_CLASS *	trek::CreateLimitAlarm ()
	Creates a LimitAlarm object. More...
Packet EXPORT_THIS_DATA_API_CLASS *	trek::CreatePacket ()
	Creates a CreatePacket object. More...
Parameter EXPORT_THIS_DATA_API_CLASS *	trek::CreateParameter ()
	Creates a CreateParameter object. More...
ParameterCollection EXPORT_THIS_DATA_API_CLASS *	trek::CreateParameterCollection ()
	Creates a ParameterCollection object. More...
ParameterStatus EXPORT_THIS_DATA_API_CLASS *	trek::CreateParameterStatus ()
	Creates a ParameterStatus object. More...
PolynomialCalibrator EXPORT_THIS_DATA_API_CLASS *	trek::CreatePolynomialCalibrator ()
	Creates a PolynomialCalibrator object. More...
RandomPacketCollection EXPORT_THIS_DATA_API_CLASS *	trek::CreateRandomPacketCollection ()
	Creates an CreateRandomPacketCollection object. More...
RangeEnumerator EXPORT_THIS_DATA_API_CLASS *	trek::CreateRangeEnumerator ()
	Creates an RangeEnumerator object. More...
SplineCalibrator EXPORT_THIS_DATA_API_CLASS *	trek::CreateSplineCalibrator ()
	Creates a SplineCalibrator object. More...
StringArray EXPORT_THIS_DATA_API_CLASS *	trek::CreateStringArray ()
	Creates a StringArray object. More...
TrekTime EXPORT_THIS_DATA_API_CLASS *	trek::CreateTrekTime ()
	Creates a TrekTime object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyCounterDependency (CounterDependency *input_ptr)
	Deletes the memory associated with a CounterDependency object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyEnumerator (Enumerator *input_ptr)
	Deletes the memory associated with a Enumerator object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyExpectedStateAlarm (ExpectedStateAlarm *input_ptr)
	Deletes the memory associated with a ExpectedStateAlarm object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyLimitAlarm (LimitAlarm *input_ptr)
	Deletes the memory associated with a LimitAlarm object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyPacket (Packet *input_ptr)
	Deletes the memory associated with a Packet object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyParameter (Parameter *input_ptr)
	Deletes the memory associated with a Parameter object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyParameterCollection (ParameterCollection *input_ptr)
	Deletes the memory associated with a ParameterCollection object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyParameterStatus (ParameterStatus *input_ptr)
	Deletes the memory associated with a ParameterStatus object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyPolynomialCalibrator (PolynomialCalibrator *input_ptr)
	Deletes the memory associated with a PolynomialCalibrator object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyRandomPacketCollection (RandomPacketCollection *input_ptr)
	Deletes the memory associated with a RandomPacketCollection object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyRangeEnumerator (RangeEnumerator *input_ptr)
	Deletes the memory associated with a RangeEnumerator object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroySplineCalibrator (SplineCalibrator *input_ptr)
	Deletes the memory associated with a SplineCalibrator object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyStringArray (StringArray *input_ptr)
	Deletes the memory associated with a StringArray object. More...
void EXPORT_THIS_DATA_API_CLASS	trek::DestroyTrekTime (TrekTime *input_ptr)
	Deletes the memory associated with a TrekTime object. More...

Detailed Description

A series of functions to handle memory creation and removal.

These functions can be used in any development environment, but should always be used to create and destory Data API classes in development environments that are not directly supported. See TReK documentation for this release to see which development environments are supported.

Function Documentation

CreateCounterDependency()

CounterDependency EXPORT_THIS_DATA_API_CLASS * trek::CreateCounterDependency

(

)

Creates an CounterDependency object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateEnumerator()

Enumerator EXPORT_THIS_DATA_API_CLASS * trek::CreateEnumerator

(

)

Creates an Enumerator object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateExpectedStateAlarm()

ExpectedStateAlarm EXPORT_THIS_DATA_API_CLASS * trek::CreateExpectedStateAlarm

(

)

Creates a ExpectedStateAlarm object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateLimitAlarm()

LimitAlarm EXPORT_THIS_DATA_API_CLASS * trek::CreateLimitAlarm

(

)

Creates a LimitAlarm object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreatePacket()

Packet EXPORT_THIS_DATA_API_CLASS * trek::CreatePacket

(

)

Creates a CreatePacket object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateParameter()

Parameter EXPORT_THIS_DATA_API_CLASS * trek::CreateParameter

(

)

Creates a CreateParameter object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateParameterCollection()

ParameterCollection EXPORT_THIS_DATA_API_CLASS * trek::CreateParameterCollection

(

)

Creates a ParameterCollection object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateParameterStatus()

ParameterStatus EXPORT_THIS_DATA_API_CLASS * trek::CreateParameterStatus

(

)

Creates a ParameterStatus object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreatePolynomialCalibrator()

PolynomialCalibrator EXPORT_THIS_DATA_API_CLASS * trek::CreatePolynomialCalibrator

(

)

Creates a PolynomialCalibrator object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateRandomPacketCollection()

RandomPacketCollection EXPORT_THIS_DATA_API_CLASS * trek::CreateRandomPacketCollection

(

)

Creates an CreateRandomPacketCollection object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateRangeEnumerator()

RangeEnumerator EXPORT_THIS_DATA_API_CLASS * trek::CreateRangeEnumerator

(

)

Creates an RangeEnumerator object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateSplineCalibrator()

SplineCalibrator EXPORT_THIS_DATA_API_CLASS * trek::CreateSplineCalibrator

(

)

Creates a SplineCalibrator object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateStringArray()

StringArray EXPORT_THIS_DATA_API_CLASS * trek::CreateStringArray

(

)

Creates a StringArray object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

CreateTrekTime()

TrekTime EXPORT_THIS_DATA_API_CLASS * trek::CreateTrekTime

(

)

Creates a TrekTime object.

Can be used by applications not running a currently supported compiler to create the memory necessary for the object.

DestroyCounterDependency()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyCounterDependency

(

CounterDependency *

input_ptr

)

Deletes the memory associated with a CounterDependency object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyEnumerator()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyEnumerator

(

Enumerator *

input_ptr

)

Deletes the memory associated with a Enumerator object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyExpectedStateAlarm()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyExpectedStateAlarm

(

ExpectedStateAlarm *

input_ptr

)

Deletes the memory associated with a ExpectedStateAlarm object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyLimitAlarm()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyLimitAlarm

(

LimitAlarm *

input_ptr

)

Deletes the memory associated with a LimitAlarm object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyPacket()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyPacket

(

Packet *

input_ptr

)

Deletes the memory associated with a Packet object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyParameter()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyParameter

(

Parameter *

input_ptr

)

Deletes the memory associated with a Parameter object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyParameterCollection()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyParameterCollection

(

ParameterCollection *

input_ptr

)

Deletes the memory associated with a ParameterCollection object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyParameterStatus()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyParameterStatus

(

ParameterStatus *

input_ptr

)

Deletes the memory associated with a ParameterStatus object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyPolynomialCalibrator()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyPolynomialCalibrator

(

PolynomialCalibrator *

input_ptr

)

Deletes the memory associated with a PolynomialCalibrator object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyRandomPacketCollection()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyRandomPacketCollection

(

RandomPacketCollection *

input_ptr

)

Deletes the memory associated with a RandomPacketCollection object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyRangeEnumerator()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyRangeEnumerator

(

RangeEnumerator *

input_ptr

)

Deletes the memory associated with a RangeEnumerator object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroySplineCalibrator()

void EXPORT_THIS_DATA_API_CLASS trek::DestroySplineCalibrator

(

SplineCalibrator *

input_ptr

)

Deletes the memory associated with a SplineCalibrator object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyStringArray()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyStringArray

(

StringArray *

input_ptr

)

Deletes the memory associated with a StringArray object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete

DestroyTrekTime()

void EXPORT_THIS_DATA_API_CLASS trek::DestroyTrekTime

(

TrekTime *

input_ptr

)

Deletes the memory associated with a TrekTime object.

Can be used by applications not running a currently supported compiler to delete the memory for the object.

Parameters

input_ptr

the object to delete