OGF::ogf_declare_struct< T > Class Template Reference

A class to declare a new struct type. More...

#include <OGF/gom/types/gom_implementation.h>

Public Member Functions
	ogf_declare_struct (const std::string &type_name)
	Declares a new struct type.
	operator MetaBuiltinStruct * ()
	Gets the created MetaBuiltinStruct object.
MetaBuiltinStruct *	operator-> ()
	Gets the created MetaBuiltinStruct object.

Detailed Description

template<class T>
class OGF::ogf_declare_struct< T >

A class to declare a new struct type.

Template Parameters

T	the struct type to be declared

Example of use:

ogf_declare_struct<SurfaceStyle>("OGF::SurfaceStyle")
 ->ogf_add_field(SurfaceStyle, visible)
 ->ogf_add_field(SurfaceStyle, color);

Note

Used by the C++ code created by GOMGEN. Client code should not use these functions.

Definition at line 330 of file gom_implementation.h.

Constructor & Destructor Documentation

ogf_declare_struct()

template<class T >

OGF::ogf_declare_struct< T >::ogf_declare_struct ( const std::string &  type_name )

inlineexplicit

Declares a new struct type.

Parameters

[in]

type_name

the C++ type name of the struct to be declared

Definition at line 337 of file gom_implementation.h.

Member Function Documentation

operator MetaBuiltinStruct *()

template<class T >

OGF::ogf_declare_struct< T >::operator MetaBuiltinStruct * ( )

inline

Gets the created MetaBuiltinStruct object.

Returns

a pointer to the created MetaBuiltinStruct object

Definition at line 351 of file gom_implementation.h.

operator->()

template<class T >

MetaBuiltinStruct * OGF::ogf_declare_struct< T >::operator-> ( )

inline

Gets the created MetaBuiltinStruct object.

To be able to write ogf_declare_struct<XXX>("XXX")->add_field<YYY>("zzz")

Returns

a pointer to the created MetaBuiltinStruct object

Definition at line 361 of file gom_implementation.h.

---

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

• OGF/gom/types/gom_implementation.h