This class has no summary. More...

#include </home/lars/safir/safir-sdk-core/src/safir_dou/gen/cpp/include/Safir/Dob/PersistenceParameters.h>

Inheritance diagram for Safir::Dob::PersistenceParameters:

Collaboration diagram for Safir::Dob::PersistenceParameters:

Public Member Functions
	PersistenceParameters ()

Safir::Dob::Typesystem::ObjectPtr	Clone () const override
	Create a copy of the object.

Safir::Dob::Typesystem::TypeId	GetTypeId () const override
	Get the type id of this object.

bool	IsChanged () override
	Check if any member of this object is changed.

void	SetChanged (const bool changed) override
	Recursively set change flags in all members of this object.

Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) override
	Get a reference to a member container from an object.

const Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const override
	Get a const reference to a member container from an object.

void	WriteToBlob (Safir::Dob::Typesystem::Int64 handle) const override
	Write the object to a blob.

	PersistenceParameters (Safir::Dob::Typesystem::Int64 handle)

Public Member Functions inherited from Safir::Dob::Parametrization
	Parametrization ()

	Parametrization (Safir::Dob::Typesystem::Int64 handle)

Public Member Functions inherited from Safir::Dob::Typesystem::Object
	Object ()
	Default constructor.

virtual	~Object ()
	Virtual destructor.

	Object (Safir::Dob::Typesystem::Int64 handle)
	Create an Object from a blob.

Static Public Member Functions
static PersistenceParametersPtr	Create ()

static Safir::Dob::PersistenceBackend::Enumeration	Backend (const Safir::Dob::Typesystem::TypeId enumId=Safir::Dob::PersistenceBackend::Checksum)
	Which backend should DOPE use (Currently 'None', 'File', and 'Odbc' are supported).

static std::wstring	FileStoragePath ()
	Full path where the File storage backend stores its data.

static std::wstring	OdbcStorageConnectString ()
	The string to use for connection to the physical storage.

static Safir::Dob::Typesystem::Int32	XmlDataColumnSize ()
	The number of bytes that can be written for each entry to the XmlData column in the database.

static Safir::Dob::Typesystem::Int32	TypeNameColumnSize ()
	The number of bytes that can be written for each entry to the TypeName column in the database.

static Safir::Dob::Typesystem::Int32	BinaryDataColumnSize ()
	The size of the BinaryData column in the database.

static Safir::Dob::Typesystem::Int32	BinarySmallDataColumnSize ()
	The size of the BinarySmallData column in the database.

static bool	StandaloneMode ()
	StandaloneMode means that each dope that is started is saving its own persistent data.

static bool	TestMode ()
	TestMode allow initial injections without persistence started.

Static Public Member Functions inherited from Safir::Dob::Parametrization
static ParametrizationPtr	Create ()

Static Public Member Functions inherited from Safir::Dob::Typesystem::Object
static Dob::Typesystem::ObjectPtr	Create ()
	Creates a new Object.

Static Public Attributes
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 8276373340234567943LL
	Type id for PersistenceParameters.

Static Public Attributes inherited from Safir::Dob::Parametrization
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 8075666004421608370LL
	Type id for Parametrization.

Static Public Attributes inherited from Safir::Dob::Typesystem::Object
static const Dob::Typesystem::TypeId	ClassTypeId = 5955188366590963785LL
	The TypeId of the Object class.

Detailed Description

This class has no summary.

Constructor & Destructor Documentation

◆ PersistenceParameters() [1/2]

Safir::Dob::PersistenceParameters::PersistenceParameters ( )

◆ PersistenceParameters() [2/2]

Safir::Dob::PersistenceParameters::PersistenceParameters ( Safir::Dob::Typesystem::Int64 handle )

explicit

Member Function Documentation

◆ Backend()

static Safir::Dob::PersistenceBackend::Enumeration Safir::Dob::PersistenceParameters::Backend ( const Safir::Dob::Typesystem::TypeId enumId = Safir::Dob::PersistenceBackend::Checksum )

static

Which backend should DOPE use (Currently 'None', 'File', and 'Odbc' are supported).

◆ BinaryDataColumnSize()

static Safir::Dob::Typesystem::Int32 Safir::Dob::PersistenceParameters::BinaryDataColumnSize ( )

static

The size of the BinaryData column in the database.

Unit is bytes.

◆ BinarySmallDataColumnSize()

static Safir::Dob::Typesystem::Int32 Safir::Dob::PersistenceParameters::BinarySmallDataColumnSize ( )

static

The size of the BinarySmallData column in the database.

Unit is bytes.

◆ Clone()

Safir::Dob::Typesystem::ObjectPtr Safir::Dob::PersistenceParameters::Clone ( ) const

overridevirtual

Create a copy of the object.

Will create a copy of the object on the heap and return a smart pointer to it. Use std::static_pointer_cast or std::dynamic_pointer_cast to cast it to the pointer type that you're after.

Returns: A smart pointer to the copy of the object.

Reimplemented from Safir::Dob::Parametrization.

◆ Create()

static PersistenceParametersPtr Safir::Dob::PersistenceParameters::Create ( )

static

◆ FileStoragePath()

static std::wstring Safir::Dob::PersistenceParameters::FileStoragePath ( )

static

Full path where the File storage backend stores its data.

Use forward slashes as directory separator!

◆ GetMember() [1/2]

const Safir::Dob::Typesystem::ContainerBase & Safir::Dob::PersistenceParameters::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index ) const

overridevirtual

Get a const reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A const reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Parametrization.

◆ GetMember() [2/2]

Safir::Dob::Typesystem::ContainerBase & Safir::Dob::PersistenceParameters::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index )

overridevirtual

Get a reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Parametrization.

◆ GetTypeId()

Safir::Dob::Typesystem::TypeId Safir::Dob::PersistenceParameters::GetTypeId ( ) const

overridevirtual

Get the type id of this object.

Gets the type id of the object. Method is virtual to ensure that the right value gets returned for pointers or references.

Note: this method is overridden by all auto-generated classes.

Returns: The TypeId of the object.

Reimplemented from Safir::Dob::Parametrization.

◆ IsChanged()

bool Safir::Dob::PersistenceParameters::IsChanged ( )

overridevirtual

Check if any member of this object is changed.

This method will recursively check if any member of the object has its change flag set.

Note: this method is overridden by all auto-generated classes.

Returns: True if any member has changed.

Reimplemented from Safir::Dob::Parametrization.

◆ OdbcStorageConnectString()

static std::wstring Safir::Dob::PersistenceParameters::OdbcStorageConnectString ( )

static

The string to use for connection to the physical storage.

◆ SetChanged()

void Safir::Dob::PersistenceParameters::SetChanged ( const bool changed )

overridevirtual

Recursively set change flags in all members of this object.

Note: this method is overridden by all auto-generated classes.

Parameters

changed [in] - The value to set the change flags to

Reimplemented from Safir::Dob::Parametrization.

◆ StandaloneMode()

static bool Safir::Dob::PersistenceParameters::StandaloneMode ( )

static

StandaloneMode means that each dope that is started is saving its own persistent data.

Only valid if when several dope_main runs on different nodes in a redundant system. Use with extreme caution. You are responsible for starting the nodes in the correct order! THIS FUNCTIONALITY IS DEPRECATED

◆ TestMode()

static bool Safir::Dob::PersistenceParameters::TestMode ( )

static

TestMode allow initial injections without persistence started.

◆ TypeNameColumnSize()

static Safir::Dob::Typesystem::Int32 Safir::Dob::PersistenceParameters::TypeNameColumnSize ( )

static

The number of bytes that can be written for each entry to the TypeName column in the database.

Note that this is not in characters, but in bytes, so depending on the value of TextColumnsAreUtf8 and your platform a character can be from 1 to 4 bytes.

◆ WriteToBlob()

void Safir::Dob::PersistenceParameters::WriteToBlob ( Safir::Dob::Typesystem::Int64 handle ) const

overridevirtual

Write the object to a blob.

Parameters

handle [in] - Handle to a blobWriter that is the destination of the serialized object.

Reimplemented from Safir::Dob::Parametrization.

◆ XmlDataColumnSize()

static Safir::Dob::Typesystem::Int32 Safir::Dob::PersistenceParameters::XmlDataColumnSize ( )

static

The number of bytes that can be written for each entry to the XmlData column in the database.

Note that this is not in characters, but in bytes, so depending on the value of TextColumnsAreUtf8 and your platform a character can be from 1 to 4 bytes.

Member Data Documentation

◆ ClassTypeId

const Safir::Dob::Typesystem::TypeId Safir::Dob::PersistenceParameters::ClassTypeId = 8276373340234567943LL

static

Type id for PersistenceParameters.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PersistenceParameters() [1/2]

◆ PersistenceParameters() [2/2]

Member Function Documentation

◆ Backend()

◆ BinaryDataColumnSize()

◆ BinarySmallDataColumnSize()

◆ Clone()

◆ Create()

◆ FileStoragePath()

◆ GetMember() [1/2]

◆ GetMember() [2/2]

◆ GetTypeId()

◆ IsChanged()

◆ OdbcStorageConnectString()

◆ SetChanged()

◆ StandaloneMode()

◆ TestMode()

◆ TypeNameColumnSize()

◆ WriteToBlob()

◆ XmlDataColumnSize()

Member Data Documentation

◆ ClassTypeId