ts3d::A3DGlobalWrapper Struct Reference

Provides a wrapper for accessing A3DGlobalData. More...

#include <ExchangeToolkit.h>

Public Types
using	DataType = A3DGlobalData
	Alias for the data type.

Public Member Functions
	A3DGlobalWrapper (A3DGlobal *ntt=nullptr)
	Constructs a wrapper, initializing the data storage with values obtained using the provided pointer and A3DRootBaseGet. More...
	~A3DGlobalWrapper (void)
	The destructor is implemented to call A3DGlobalGet( nullptr, &_d ) to ensure dynamic resources are freed.
DataType const *	operator-> () const
	Const data access to A3DGlobalData.
DataType *	operator-> ()
	Non-const data access to A3DGlobalData. More...
void	reset (A3DGlobal *ntt)
	Resets internal data to values obtained from the provided pointer. More...

Public Attributes
DataType	_d
	Data storage.

Detailed Description

Provides a wrapper for accessing A3DGlobalData.

Constructor & Destructor Documentation

ts3d::A3DGlobalWrapper::A3DGlobalWrapper ( A3DGlobal *  ntt = nullptr )

inline

Constructs a wrapper, initializing the data storage with values obtained using the provided pointer and A3DRootBaseGet.

This can be a nullptr, in which case the A3DRootBaseData struct is initialized but not populated.

Member Function Documentation

DataType* ts3d::A3DGlobalWrapper::operator-> ( )

inline

Non-const data access to A3DGlobalData.

Note

If you modify the data and expect the underlying Exchange data model to be updated, you must explicitly call the correct Create or Set function in the Exchange API. This wrapper does not provide write capability.

Todo:

Implement write capability?

void ts3d::A3DGlobalWrapper::reset ( A3DGlobal *  ntt )

inline

Resets internal data to values obtained from the provided pointer.

Calling this function will free dynamic resources as needed prior to obtaining new values in the struct. If a nullptr is provided, the data is not explicitly changed and may reflect old values.

---

The documentation for this struct was generated from the following file:

• /home/travis/build/techsoft3d/ExchangeToolkit/ExchangeToolkit/include/ExchangeToolkit.h