rwlogo

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Macros | Functions
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
classNameThe 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
classNameThe name of the projection class.
superClassNameThe name of the superclass of the projection.
projectionNameThe name of the projection. This name is used to initialize the IlvProjectionClassInfo's projection name.
constructorStatementThe 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.
initializationStatementAny 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
classNameThe name of the projection class.
superClassNameThe name of the superclass of the projection.
projectionNameThe name of the projection. This name is used to initialize the IlvProjectionClassInfo's projection name.
constructorStatementThe 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.
initializationStatementAny 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
classNameThe class name.

Function Documentation

void IlvMapsEmptyStatement ( )

A default empty statement.

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


© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.