Safir::Dob::Service Class Reference

The baseclass for all services. More...

#include <Safir/Dob/Service.h>

Inheritance diagram for Safir::Dob::Service:

Collaboration diagram for Safir::Dob::Service:

Public Member Functions
	Service ()
virtual Safir::Dob::Typesystem::ObjectPtr	Clone () const
	Create a copy of the object. More...
virtual Safir::Dob::Typesystem::TypeId	GetTypeId () const
	Get the type id of this object. More...
virtual bool	IsChanged ()
	Check if any member of this object is changed. More...
virtual void	SetChanged (const bool changed)
	Recursively set change flags in all members of this object. More...
virtual Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index)
	Get a reference to a member container from an object. More...
virtual const Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const
	Get a const reference to a member container from an object. More...
virtual Safir::Dob::Typesystem::Int32	CalculateBlobSize () const
	Calculate the size of the blob-serialized form of this object. More...
virtual void	WriteToBlob (char *blob, char *&beginningOfUnused) const
	Write the object to a blob. More...
	Service (char const *const blob)
Public Member Functions inherited from Safir::Dob::Typesystem::Object
	Object ()
	Default constructor. More...
virtual	~Object ()
	Virtual destructor. More...
	Object (char const *const blob)
	Create an Object from a blob. More...

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

Static Public Attributes
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = -5315939293064264373LL
	Type id for Service. More...
Static Public Attributes inherited from Safir::Dob::Typesystem::Object
static const Dob::Typesystem::TypeId	ClassTypeId = 5955188366590963785LL
	The TypeId of the Object class. More...

Detailed Description

The baseclass for all services.

Constructor & Destructor Documentation

Safir::Dob::Service::Service

(

)

Safir::Dob::Service::Service ( char const *const  blob )

explicit

Member Function Documentation

virtual Safir::Dob::Typesystem::Int32 Safir::Dob::Service::CalculateBlobSize ( ) const

virtual

Calculate the size of the blob-serialized form of this object.

Returns

The needed size in bytes.

Reimplemented from Safir::Dob::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

virtual Safir::Dob::Typesystem::ObjectPtr Safir::Dob::Service::Clone ( ) const

virtual

Create a copy of the object.

Will create a copy of the object on the heap and return a smart pointer to it. Use boost::static_pointer_cast or boost::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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

static ServicePtr Safir::Dob::Service::Create ( )

static

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

virtual

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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

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

virtual

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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

virtual Safir::Dob::Typesystem::TypeId Safir::Dob::Service::GetTypeId ( ) const

virtual

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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

virtual bool Safir::Dob::Service::IsChanged ( )

virtual

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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

virtual void Safir::Dob::Service::SetChanged ( const bool  changed )

virtual

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::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

virtual void Safir::Dob::Service::WriteToBlob ( char *  blob, char *&  beginningOfUnused  ) const

virtual

Write the object to a blob.

Note that the size of the blob is assumed to be correct! No checks are made!

Parameters

blob	[in,out] - The blob to write to.
beginningOfUnused	[in,out] - The beginning of unused dynamic blob space.

Reimplemented from Safir::Dob::Typesystem::Object.

Reimplemented in Safir::Utilities::ForEach::DeleteAllRequest, Safir::Utilities::ForEach::UpdateRequest, Safir::Utilities::ForEach::DeleteRequest, and Safir::Dob::PersistentDataReady.

Member Data Documentation

const Safir::Dob::Typesystem::TypeId Safir::Dob::Service::ClassTypeId = -5315939293064264373LL

static

Type id for Service.