TSLGMLApplicationSchemaCreationParameters Class Reference

Detailed Description

An instance of this class should be passed to the TSLGMLApplicationSchema Factory to create a GML application schema, represented by a TSLGMLApplicationSchema object.

It is used to define certain properties of the schema, such as the version, target namespace, desired target namespace prefix and if the schema should conform to a supported schema profile.

Public Member Functions
	TSLGMLApplicationSchemaCreationParameters ()
void	destroy ()
const TSLGMLApplicationSchemaProfileParameters *	profile () const
void	profile (TSLGMLApplicationSchemaProfileParameters *profile)
const char *	targetNamespace () const
void	targetNamespace (const char *ns)
const char *	targetNamespacePrefix () const
void	targetNamespacePrefix (const char *prefix)
unsigned int	versionMajor () const
void	versionMajor (unsigned int major)
unsigned int	versionMinor () const
void	versionMinor (unsigned int minor)
void *	operator new (size_t size)
void *	operator new (size_t size, char *filename, int line)

Constructor & Destructor Documentation

TSLGMLApplicationSchemaCreationParameters()

TSLGMLApplicationSchemaCreationParameters::TSLGMLApplicationSchemaCreationParameters

(

)

Default constructor

Member Function Documentation

destroy()

void TSLGMLApplicationSchemaCreationParameters::destroy

(

)

Destroy this object.

This method must be used instead of delete.

operator new() [1/2]

void * TSLGMLApplicationSchemaCreationParameters::operator new

(

size_t

size

)

operator new() [2/2]

void * TSLGMLApplicationSchemaCreationParameters::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

profile() [1/2]

const TSLGMLApplicationSchemaProfileParameters * TSLGMLApplicationSchemaCreationParameters::profile

(

)

const

Queries the profile specific parameters of the GML application schema to be created.

If this method returns null, then the schema will not declare its conformance to any GML profile.

Currently the only GML profile supported is the GML Simple Features (SF) profile.

profile() [2/2]

void TSLGMLApplicationSchemaCreationParameters::profile

(

TSLGMLApplicationSchemaProfileParameters *

profile

)

Sets the parameters of the GML application schema profile that the schema to be created should declare its conformance to.

Either an instance of a class that derives from TSLGMLApplicationSchema Profile or null should be passed. Null clears the currently set profile parameters - implying that the schema to be created should not conform to a profile.

Currently the only GML profile supported is the GML Simple Features (SF) profile.

Parameters

profile

The parameters of the GML application schema proifile that the schema to be created should declare its conformance to. If null, then no conformance shall be declared. This class takes ownership of the profile parameters passed.

targetNamespace() [1/2]

const char * TSLGMLApplicationSchemaCreationParameters::targetNamespace

(

)

const

Queries the target namespace of the schema.

targetNamespace() [2/2]

void TSLGMLApplicationSchemaCreationParameters::targetNamespace

(

const char *

ns

)

Sets the target namespace of the schema. This should be a valid URN string.

Parameters

ns	The new target namespace of the schema. Null is not a valid value and will cause an error to be placed on the error stack.

targetNamespacePrefix() [1/2]

const char * TSLGMLApplicationSchemaCreationParameters::targetNamespacePrefix

(

)

const

Queries the current target namespace prefix of the GML application schema to be created. An empty prefix string causes the target namespace to become the default namespace of the document. If the prefix specified clashes with a an existing prefix, then a new prefix will be generated.

By default, the prefix will be 'ns1'.

targetNamespacePrefix() [2/2]

void TSLGMLApplicationSchemaCreationParameters::targetNamespacePrefix

(

const char *

prefix

)

Sets the desired target namespace prefix that will be used when writing the schema to a file or buffer. Setting the target namespace prefix to the empty string will cause the target namespace to become the default namespace of the document. If the prefix specified clashes with a an existing prefix, then a new prefix will be generated.

By default, the prefix will be 'ns1'.

Parameters

prefix

The desired target namespace prefix. Null is not a valid value and will cause an error to be placed on the error stack.

versionMajor() [1/2]

unsigned int TSLGMLApplicationSchemaCreationParameters::versionMajor

(

)

const

Queries the major version of the application schema to be created. By default the schema version is 1.0.

versionMajor() [2/2]

void TSLGMLApplicationSchemaCreationParameters::versionMajor

(

unsigned int

major

)

Sets the major version of the application schema to be created. By default the schema version is 1.0.

Parameters

major

The new major version.

versionMinor() [1/2]

unsigned int TSLGMLApplicationSchemaCreationParameters::versionMinor

(

)

const

Queries the minor version of the application schema to be created. By default the schema version is 1.0.

versionMinor() [2/2]

void TSLGMLApplicationSchemaCreationParameters::versionMinor

(

unsigned int

minor

)

Sets the minor version of the application schema to be created. By default the schema version is 1.0.

Parameters

minor

The new minor version.