Node information for all nodes currently in the system. More...

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

Inheritance diagram for Safir::Dob::NodeInfo:

Collaboration diagram for Safir::Dob::NodeInfo:

Public Member Functions
	NodeInfo ()

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

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	NodeName () const
	The name of the node.

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	NodeName ()

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	IpAddress () const
	The Ip address used by the node.

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	IpAddress ()

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	NodeType () const
	The node type of the node.

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer >	NodeType ()

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::NodeState::EnumerationContainer >	State () const
	This is the current state of the node.

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::NodeState::EnumerationContainer >	State ()

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::MemoryLevel::EnumerationContainer >	MemoryLevel () const
	Current shared memory usage level of the node.

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::MemoryLevel::EnumerationContainer >	MemoryLevel ()

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.

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

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

	Entity (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 NodeInfoPtr	Create ()

static Safir::Dob::Typesystem::MemberIndex	NodeNameMemberIndex ()

static Safir::Dob::Typesystem::Int32	NodeNameMaxStringLength ()

static Safir::Dob::Typesystem::MemberIndex	IpAddressMemberIndex ()

static Safir::Dob::Typesystem::Int32	IpAddressMaxStringLength ()

static Safir::Dob::Typesystem::MemberIndex	NodeTypeMemberIndex ()

static Safir::Dob::Typesystem::Int32	NodeTypeMaxStringLength ()

static Safir::Dob::Typesystem::MemberIndex	StateMemberIndex ()

static Safir::Dob::Typesystem::MemberIndex	MemoryLevelMemberIndex ()

Static Public Member Functions inherited from Safir::Dob::Entity
static EntityPtr	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 = -7384790295819199437LL
	Type id for NodeInfo.

Static Public Attributes inherited from Safir::Dob::Entity
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = -2411771300820206595LL
	Type id for Entity.

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

Detailed Description

Node information for all nodes currently in the system.

The instance corresponds to the node id. Note that light nodes will not be able to see other light node's instances of this class. See User's Guide for more information.

Constructor & Destructor Documentation

◆ NodeInfo() [1/2]

Safir::Dob::NodeInfo::NodeInfo ( )

◆ NodeInfo() [2/2]

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

explicit

Member Function Documentation

◆ Clone()

Safir::Dob::Typesystem::ObjectPtr Safir::Dob::NodeInfo::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::Entity.

◆ Create()

static NodeInfoPtr Safir::Dob::NodeInfo::Create ( )

static

◆ GetMember() [1/2]

const Safir::Dob::Typesystem::ContainerBase & Safir::Dob::NodeInfo::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::Entity.

◆ GetMember() [2/2]

Safir::Dob::Typesystem::ContainerBase & Safir::Dob::NodeInfo::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::Entity.

◆ GetTypeId()

Safir::Dob::Typesystem::TypeId Safir::Dob::NodeInfo::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::Entity.

◆ IpAddress() [1/2]

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::IpAddress ( )

◆ IpAddress() [2/2]

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::IpAddress ( ) const

The Ip address used by the node.

◆ IpAddressMaxStringLength()

static Safir::Dob::Typesystem::Int32 Safir::Dob::NodeInfo::IpAddressMaxStringLength ( )

static

◆ IpAddressMemberIndex()

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::NodeInfo::IpAddressMemberIndex ( )

static

◆ IsChanged()

bool Safir::Dob::NodeInfo::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::Entity.

◆ MemoryLevel() [1/2]

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::MemoryLevel::EnumerationContainer > Safir::Dob::NodeInfo::MemoryLevel ( )

◆ MemoryLevel() [2/2]

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::MemoryLevel::EnumerationContainer > Safir::Dob::NodeInfo::MemoryLevel ( ) const

Current shared memory usage level of the node.

This value will never be set to Full, since it is impossible to actually update entities then.

◆ MemoryLevelMemberIndex()

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::NodeInfo::MemoryLevelMemberIndex ( )

static

◆ NodeName() [1/2]

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::NodeName ( )

◆ NodeName() [2/2]

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::NodeName ( ) const

The name of the node.

◆ NodeNameMaxStringLength()

static Safir::Dob::Typesystem::Int32 Safir::Dob::NodeInfo::NodeNameMaxStringLength ( )

static

◆ NodeNameMemberIndex()

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::NodeInfo::NodeNameMemberIndex ( )

static

◆ NodeType() [1/2]

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::NodeType ( )

◆ NodeType() [2/2]

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::Typesystem::StringContainer > Safir::Dob::NodeInfo::NodeType ( ) const

The node type of the node.

◆ NodeTypeMaxStringLength()

static Safir::Dob::Typesystem::Int32 Safir::Dob::NodeInfo::NodeTypeMaxStringLength ( )

static

◆ NodeTypeMemberIndex()

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::NodeInfo::NodeTypeMemberIndex ( )

static

◆ SetChanged()

void Safir::Dob::NodeInfo::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::Entity.

◆ State() [1/2]

Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::NodeState::EnumerationContainer > Safir::Dob::NodeInfo::State ( )

◆ State() [2/2]

const Safir::Dob::Typesystem::ContainerProxy< Safir::Dob::NodeState::EnumerationContainer > Safir::Dob::NodeInfo::State ( ) const

This is the current state of the node.

For non light nodes this will be 'Normal'. For light nodes this can be Detached, Attaching, Attached.

◆ StateMemberIndex()

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::NodeInfo::StateMemberIndex ( )

static

◆ WriteToBlob()

void Safir::Dob::NodeInfo::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::Entity.

Member Data Documentation

◆ ClassTypeId

const Safir::Dob::Typesystem::TypeId Safir::Dob::NodeInfo::ClassTypeId = -7384790295819199437LL

static

Type id for NodeInfo.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NodeInfo() [1/2]

◆ NodeInfo() [2/2]

Member Function Documentation

◆ Clone()

◆ Create()

◆ GetMember() [1/2]

◆ GetMember() [2/2]

◆ GetTypeId()

◆ IpAddress() [1/2]

◆ IpAddress() [2/2]

◆ IpAddressMaxStringLength()

◆ IpAddressMemberIndex()

◆ IsChanged()

◆ MemoryLevel() [1/2]

◆ MemoryLevel() [2/2]

◆ MemoryLevelMemberIndex()

◆ NodeName() [1/2]

◆ NodeName() [2/2]

◆ NodeNameMaxStringLength()

◆ NodeNameMemberIndex()

◆ NodeType() [1/2]

◆ NodeType() [2/2]

◆ NodeTypeMaxStringLength()

◆ NodeTypeMemberIndex()

◆ SetChanged()

◆ State() [1/2]

◆ State() [2/2]

◆ StateMemberIndex()

◆ WriteToBlob()

Member Data Documentation

◆ ClassTypeId