BcfCommon.h File Reference

#include "OdPlatformSettings.h"
#include "IfcBuildOptions.h"
#include "RxObject.h"
#include "SmartPtr.h"
#include "BcfUnset.h"

Go to the source code of this file.

Namespaces
namespace	OdBcf

Macros
#define	MAX_ENTITY_COLLECTION_SIZE   1024
#define	FILE_BUFFER_SIZE   1024
#define	PROJECT_FILE_NAME   "project.bcfp"
#define	VERSION_FILE_NAME   "bcf.version"
#define	MARKUP_FILE_NAME   "markup.bcf"
#define	DEFAULT_VIEWPOINT_FILE_NAME   "viewpoint.bcfv"
#define	VIEWPOINT_FILE_EXTENSION   "bcfv"
#define	DEFAULT_SNAPSHOT_FILE_NAME   "snapshot.png"
#define	SNAPSHOT_FILE_EXTENSION   "png"
#define	DECLARE_SET(MethodName, VariableType, VariableName)
#define	DEFINE_SET(ClassName, MethodName, VariableType, VariableName)
#define	DECLARE_GET(MethodName, VariableType, VariableName)
#define	DEFINE_GET(ClassName, MethodName, VariableType, VariableName)
#define	DECLARE_CONST_ACCESSORS(MethodName, VariableType, VariableName)
#define	DEFINE_CONST_ACCESSORS(ClassName, MethodName, VariableType, VariableName)
#define	DECLARE_ACCESSORS(MethodName, VariableType, VariableName)
#define	DEFINE_ACCESSORS(ClassName, MethodName, VariableType, VariableName)
#define	INIT_RESULT(VariableName)

Macro Definition Documentation

DECLARE_ACCESSORS

#define DECLARE_ACCESSORS	(		MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
DECLARE_SET(      MethodName, VariableType, VariableName)                         \
DECLARE_GET(      MethodName, VariableType, VariableName)                         \
DECLARE_CONST_ACCESSORS(MethodName, VariableType, VariableName)

Definition at line 91 of file BcfCommon.h.

DECLARE_CONST_ACCESSORS

#define DECLARE_CONST_ACCESSORS	(		MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
const VariableType& get##MethodName() const;                                      \
                                                                                  \
bool is##MethodName##Unset() const;

Definition at line 73 of file BcfCommon.h.

DECLARE_GET

#define DECLARE_GET	(		MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
VariableType& get##MethodName();

Definition at line 62 of file BcfCommon.h.

DECLARE_SET

#define DECLARE_SET	(		MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
void set##MethodName(const VariableType &VariableName##Value);

Definition at line 51 of file BcfCommon.h.

DEFAULT_SNAPSHOT_FILE_NAME

#define DEFAULT_SNAPSHOT_FILE_NAME   "snapshot.png"

Definition at line 48 of file BcfCommon.h.

DEFAULT_VIEWPOINT_FILE_NAME

#define DEFAULT_VIEWPOINT_FILE_NAME   "viewpoint.bcfv"

Definition at line 46 of file BcfCommon.h.

DEFINE_ACCESSORS

#define DEFINE_ACCESSORS	(		ClassName,
			MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
DEFINE_SET(      ClassName, MethodName, VariableType, VariableName)               \
DEFINE_GET(      ClassName, MethodName, VariableType, VariableName)               \
DEFINE_CONST_ACCESSORS(ClassName, MethodName, VariableType, VariableName)

Definition at line 97 of file BcfCommon.h.

DEFINE_CONST_ACCESSORS

#define DEFINE_CONST_ACCESSORS	(		ClassName,
			MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
const VariableType& ClassName::get##MethodName() const                            \
{                                                                                 \
  return VariableName;                                                            \
}                                                                                 \
                                                                                  \
bool ClassName::is##MethodName##Unset() const                                     \
{                                                                                 \
  return OdBcf::Utils::isUnset(VariableName);                                     \
}

Definition at line 79 of file BcfCommon.h.

DEFINE_GET

#define DEFINE_GET	(		ClassName,
			MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
VariableType& ClassName::get##MethodName()                                        \
{                                                                                 \
  return VariableName;                                                            \
}

Definition at line 66 of file BcfCommon.h.

DEFINE_SET

#define DEFINE_SET	(		ClassName,
			MethodName,
			VariableType,
			VariableName
	)

Value:

                                                                                  \
void ClassName::set##MethodName(const VariableType &VariableName##Value)          \
{                                                                                 \
  VariableName = VariableName##Value;                                             \
}

Definition at line 55 of file BcfCommon.h.

FILE_BUFFER_SIZE

#define FILE_BUFFER_SIZE   1024

Definition at line 41 of file BcfCommon.h.

INIT_RESULT

#define INIT_RESULT

(

VariableName

)

Value:

                                                                                  \
OdResult VariableName##Local;                                                     \
if (VariableName == NULL)                                                         \
{                                                                                 \
  VariableName = &VariableName##Local;                                            \
}                                                                                 \
*VariableName = eOk;

Definition at line 103 of file BcfCommon.h.

MARKUP_FILE_NAME

#define MARKUP_FILE_NAME   "markup.bcf"

Definition at line 45 of file BcfCommon.h.

MAX_ENTITY_COLLECTION_SIZE

#define MAX_ENTITY_COLLECTION_SIZE   1024

Definition at line 40 of file BcfCommon.h.

PROJECT_FILE_NAME

#define PROJECT_FILE_NAME   "project.bcfp"

Definition at line 43 of file BcfCommon.h.

SNAPSHOT_FILE_EXTENSION

#define SNAPSHOT_FILE_EXTENSION   "png"

Definition at line 49 of file BcfCommon.h.

VERSION_FILE_NAME

#define VERSION_FILE_NAME   "bcf.version"

Definition at line 44 of file BcfCommon.h.

VIEWPOINT_FILE_EXTENSION

#define VIEWPOINT_FILE_EXTENSION   "bcfv"

Definition at line 47 of file BcfCommon.h.