macros.h File Reference

Declaration of Rogue Wave Views Maps dedicated macros. More...

#include <ilviews/macros.h>
#include <ilviews/base/gcontext.h>

Macros
#define	IlvMapsDeclareProjectionIO(className)
	Declares all functions and data members to support persistence. More...
#define	IlvMapsDefineBasicProjectionIO(className,superClassName,projectionName,constructorStatement,initializationStatement)
	Defines a default implementation of projection IO features. More...
#define	IlvMapsDefineProjectionIO(className,superClassName,projectionName,constructorStatement,initializationStatement)
	Defines a default implementation of projection IO features. More...
#define	IlvMapsInitProjectionIO(className)
	Initialize projection IO features. More...

Functions
void	IlvMapsEmptyStatement ()
	A default empty statement. More...

Detailed Description

Declaration of Rogue Wave Views Maps dedicated macros.

Library: ilvmaps

Macro Definition Documentation

#define IlvMapsDeclareProjectionIO

(

className

)

Declares all functions and data members to support persistence.

Use this macro in the declaration of a projection class. It generates all necessary functions and data members to support persistence.

Parameters

className

The class name.

See Also

IlvMapsDefineProjectionIO(), IlvMapsDefineBasicProjectionIO().

#define IlvMapsDefineBasicProjectionIO	(		className,
			superClassName,
			projectionName,
			constructorStatement,
			initializationStatement
	)

Defines a default implementation of projection IO features.

This is the same macro as IlvMapsDefineProjectionIO(), but it is used for projections that do not save any additional data. It also generates the code for the stream constructor.

Parameters

className	The name of the projection class.
superClassName	The name of the superclass of the projection.
projectionName	The name of the projection. This name is used to initialize the IlvProjectionClassInfo's projection name.
constructorStatement	The statement used to create a new instance of the projection. This statement will be used by the IlvProjectionDictionary::CreateFunction() method to create instances of the projection class.
initializationStatement	Any statement that you need to execute during the projection class initialization. This statement is generally used to initialize the accessors or to register new error messages. If no statement is required for your class, you can use the IlvMapsEmptyStatement() function here.

See Also

IlvMapsDeclareProjectionIO(), IlvMapsDefineProjectionIO().

#define IlvMapsDefineProjectionIO	(		className,
			superClassName,
			projectionName,
			constructorStatement,
			initializationStatement
	)

Defines a default implementation of projection IO features.

Use this macro in the implementation file of a projection to enable the initialization of the projection IO features.

Parameters

className	The name of the projection class.
superClassName	The name of the superclass of the projection.
projectionName	The name of the projection. This name is used to initialize the IlvProjectionClassInfo's projection name.
constructorStatement	The statement used to create a new instance of the projection. This statement will be used by the IlvProjectionDictionary::CreateFunction() method to create instances of the projection class.
initializationStatement	Any statement that you need to execute during the projection class initialization. This statement is generally used to initialize the accessors or to register new error messages. If no statement is required for your class, you can use the IlvMapsEmptyStatement function here.

See Also

IlvMapsDeclareProjectionIO(), IlvMapsDefineBasicProjectionIO().

#define IlvMapsInitProjectionIO

(

className

)

Initialize projection IO features.

Use this macro in the header file of a projection, after the class declaration, to enable the initialization of the projection IO features.

Parameters

className

The class name.

Function Documentation

void IlvMapsEmptyStatement

(

)

A default empty statement.

A default empty statement that can be used in the IlvMapsDefineProjectionIO() IlvMapsDefineBasicProjectionIO() macros.