SALOME_InteractiveObject.hxx File Reference

#include <MMgt_TShared.hxx>
#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Basics_OCCTVersion.hxx>
#include <string>

Go to the source code of this file.

Functions
DEFINE_STANDARD_HANDLE(SALOME_InteractiveObject, MMgt_TShared) class SALOME_InteractiveObject Standard_EXPORT	SALOME_InteractiveObject (const char *anEntry, const char *aComponentDataType, const char *aName="")
virtual Standard_EXPORT	~SALOME_InteractiveObject ()
Standard_EXPORT void	setEntry (const char *anEntry)
Standard_EXPORT const char *	getEntry ()
Standard_EXPORT Standard_Boolean	hasEntry ()
Standard_EXPORT void	setName (const char *aName)
Standard_EXPORT const char *	getName ()
virtual Standard_EXPORT Standard_Boolean	isSame (const Handle(SALOME_InteractiveObject)&anIO)
Standard_EXPORT void	setReference (const char *aReference)
Standard_EXPORT const char *	getReference ()
Standard_EXPORT Standard_Boolean	hasReference ()
Standard_EXPORT void	setComponentDataType (const char *ComponentDataType)
Standard_EXPORT const char *	getComponentDataType ()
Standard_EXPORT Standard_Boolean	isComponentType (const char *ComponentDataType)
Standard_EXPORT friend Standard_Boolean	IsEqual (const Handle(SALOME_InteractiveObject)&anIO1, const Handle(SALOME_InteractiveObject)&anIO2)
	OCCT_DEFINE_STANDARD_RTTIEXT (SALOME_InteractiveObject, MMgt_TShared)}

Variables
std::string	myEntry
std::string	myName
std::string	myComponentDataType
std::string	myReference

Function Documentation

const char * SALOME_InteractiveObject::getComponentDataType

(

)

Returns

component data type

References myComponentDataType.

const char * SALOME_InteractiveObject::getEntry

(

)

Returns

entry

References myEntry.

Standard_EXPORT const char* getName

(

)

Standard_EXPORT const char* getReference

(

)

Standard_Boolean SALOME_InteractiveObject::hasEntry

(

)

Returns

true if entry isn't empty

References myEntry.

Standard_Boolean SALOME_InteractiveObject::hasReference

(

)

Returns

true if object has reference

References myReference.

Standard_Boolean SALOME_InteractiveObject::isComponentType

(

const char *

ComponentDataType

)

Returns

true if component data types are same

Parameters

ComponentDataType

- component data type to be checked

References myComponentDataType.

Standard_EXPORT friend Standard_Boolean IsEqual	(	const Handle(SALOME_InteractiveObject)&	anIO1,
		const Handle(SALOME_InteractiveObject)&	anIO2
	)

Compare two objects

Parameters

anIO1	- first object to compare
anIO1	- second object to compare

Standard_Boolean SALOME_InteractiveObject::isSame ( const Handle(SALOME_InteractiveObject)&  anIO )

virtual

Returns

true if objects have same entries

Parameters

anIO	- other object

References hasEntry(), and myEntry.

OCCT_DEFINE_STANDARD_RTTIEXT	(	SALOME_InteractiveObject	,
		MMgt_TShared
	)

SALOME_InteractiveObject::SALOME_InteractiveObject	(	const char *	anEntry,
		const char *	aComponentDataType,
		const char *	aName = ""
	)

Constructor

Parameters

anEntry	- entry of object
aComponentDataType	- component data type name
aName	- name of object

void SALOME_InteractiveObject::setComponentDataType

(

const char *

aComponentDataType

)

Sets component data type

Parameters

aComponentDataType

- component data type name

References myComponentDataType.

void SALOME_InteractiveObject::setEntry

(

const char *

anEntry

)

Sets entry

Parameters

anEntry

- new entry of object

References myEntry.

Standard_EXPORT void setName

(

const char *

aName

)

Standard_EXPORT void setReference

(

const char *

aReference

)

SALOME_InteractiveObject::~SALOME_InteractiveObject ( )

virtual

Destructor

Variable Documentation

std::string myComponentDataType

std::string myEntry

std::string myName

std::string myReference