Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Examples

corelinux::FrameworkEntity Class Reference

#include <FrameworkEntity.hpp>

Inheritance diagram for corelinux::FrameworkEntity:

List of all members.

Public Methods
virtual MetaTypePtr	getType ( void ) const
	get the type. More...
virtual bool	equals ( FrameworkEntityCptr ) const
	The equals method is defined for each FrameworkEntity type using MetaClass. More...
UniversalIdentifierCref	getOid ( void ) const
	Get the object identifier for the instance. More...
void	setOid ( UniversalIdentifierCref )
	Set the object identifier for the instance.
void*	operator new (size_t aSize)
	redefine the operator new[] aSize. More...
void	operator delete (void * aVoidPtr)
	redefine the operator delete[] aVoidPtr the pointer to delete.
Constructor and destructor
	FrameworkEntity ( void )
	All FrameworkEntity derivations require a public default constructor for instantiation via the class factory (MetaType).
	FrameworkEntity ( UniversalIdentifierCref )
	Constructor with an instance key.
virtual	~FrameworkEntity ( void )
	Virtual destructor.
Operator overloads
bool	operator== ( FrameworkEntityCref ) const
	Equality operator. More...
FrameworkEntityRef	operator= ( FrameworkEntityCref )
	Assignment operator. More...
Static Public Methods
MetaTypePtr	getTypeDescriptor ( void )
	get the type descriptor. More...
	FrameworkEntityPtr ( void )
	create a new instance of className. More...
	FrameworkEntityPtr ( UniversalIdentifierCref )
	create a new instance of className with OID. More...
	void ( FrameworkEntityPtr aPointer )
	destroy a point of className pointer to className.
FrameworkEntityCptr	castDown ( FrameworkEntityCptr )
	Cast the reference down to type.
FrameworkEntityPtr	castDown ( FrameworkEntityPtr )
	Cast the reference down to type.
FrameworkEntityCref	castDown ( FrameworkEntityCref )
	Cast the reference down to type.
FrameworkEntityRef	castDown ( FrameworkEntityRef )
	Cast the reference down to type.

Detailed Description

The root type for Framework objects. The FrameworkEntity class metatype also serves as MetaTypeRoot, which is what all metatypes are subsumed by.

Constructor & Destructor Documentation

corelinux::FrameworkEntity::FrameworkEntity ( void )

All FrameworkEntity derivations require a public default constructor for instantiation via the class factory (MetaType).

corelinux::FrameworkEntity::FrameworkEntity ( UniversalIdentifierCref aOid )

Constructor with an instance key.

corelinux::FrameworkEntity::~FrameworkEntity ( void ) [virtual]

Virtual destructor.

Member Function Documentation

corelinux::FrameworkEntity::FrameworkEntityPtr ( UniversalIdentifierCref ) [static]

create a new instance of className with OID.

Returns:
a pointer to className

corelinux::FrameworkEntity::FrameworkEntityPtr ( void ) [static]

create a new instance of className.

Returns:
a pointer to className

FrameworkEntityCref corelinux::FrameworkEntity::castDown ( FrameworkEntityRef ) [static]

Cast the reference down to type.

FrameworkEntityCref corelinux::FrameworkEntity::castDown ( FrameworkEntityCref ) [static]

Cast the reference down to type.

FrameworkEntityCref corelinux::FrameworkEntity::castDown ( FrameworkEntityPtr ) [static]

Cast the reference down to type.

FrameworkEntityCref corelinux::FrameworkEntity::castDown ( FrameworkEntityCptr ) [static]

Cast the reference down to type.

bool corelinux::FrameworkEntity::equals ( FrameworkEntityCptr ) const [virtual]

The equals method is defined for each FrameworkEntity type using MetaClass.
It compares the type, then the address of the pointer, and if needed will call out to the types operator==

UniversalIdentifierCref corelinux::FrameworkEntity::getOid ( void ) const

Get the object identifier for the instance.

Returns:
a UniversalIdentifier

MetaTypePtr corelinux::FrameworkEntity::getType ( void ) const [virtual]

get the type.

Returns:
a const pointer to the MetaType

Reimplemented in corelinux::Aggregate, corelinux::Array, corelinux::Attribute, corelinux::Boolean, corelinux::Catalog, corelinux::Collection, corelinux::Concept, corelinux::FrameworkString, corelinux::Integer, corelinux::LibraryObject, corelinux::LibraryType, corelinux::Loader, corelinux::Number, corelinux::SchemaAbstractStore, corelinux::SchemaCatalog, corelinux::SchemaCatStore, corelinux::SchemaDataDescriptor, corelinux::SchemaSponsor, corelinux::SchemaStore, corelinux::Store, corelinux::StoreCatalog, corelinux::StoreSponsor, corelinux::RealNumber, corelinux::Schema, corelinux::SetCollection, corelinux::ShortInteger, corelinux::SignedNumber, corelinux::Sponsor, corelinux::UnsignedInteger, corelinux::UnsignedNumber, corelinux::UnsignedShortInteger, and UserType.

MetaTypePtr corelinux::FrameworkEntity::getTypeDescriptor ( void ) [static]

get the type descriptor.

Returns:
a const pointer to the MetaType

Reimplemented in corelinux::Aggregate, corelinux::Array, corelinux::Attribute, corelinux::Boolean, corelinux::Catalog, corelinux::Collection, corelinux::Concept, corelinux::FrameworkString, corelinux::Integer, corelinux::LibraryObject, corelinux::LibraryType, corelinux::Loader, corelinux::Number, corelinux::SchemaAbstractStore, corelinux::SchemaCatalog, corelinux::SchemaCatStore, corelinux::SchemaDataDescriptor, corelinux::SchemaSponsor, corelinux::SchemaStore, corelinux::Store, corelinux::StoreCatalog, corelinux::StoreSponsor, corelinux::RealNumber, corelinux::Schema, corelinux::SetCollection, corelinux::ShortInteger, corelinux::SignedNumber, corelinux::Sponsor, corelinux::UnsignedInteger, corelinux::UnsignedNumber, corelinux::UnsignedShortInteger, and UserType.

void corelinux::FrameworkEntity::operator delete ( void * aVoidPtr )

redefine the operator delete[]

aVoidPtr the pointer to delete.

void * corelinux::FrameworkEntity::operator new ( size_t aSize )

redefine the operator new[]

aSize.

Returns:
a VoidPtr

Reimplemented in corelinux::Aggregate, corelinux::Array, corelinux::Attribute, corelinux::Boolean, corelinux::Catalog, corelinux::Collection, corelinux::Concept, corelinux::FrameworkString, corelinux::Integer, corelinux::LibraryObject, corelinux::LibraryType, corelinux::Loader, corelinux::Number, corelinux::SchemaAbstractStore, corelinux::SchemaCatalog, corelinux::SchemaCatStore, corelinux::SchemaDataDescriptor, corelinux::SchemaSponsor, corelinux::SchemaStore, corelinux::Store, corelinux::StoreCatalog, corelinux::StoreSponsor, corelinux::RealNumber, corelinux::Schema, corelinux::SetCollection, corelinux::ShortInteger, corelinux::SignedNumber, corelinux::Sponsor, corelinux::UnsignedInteger, corelinux::UnsignedNumber, corelinux::UnsignedShortInteger, and UserType.

FrameworkEntityRef corelinux::FrameworkEntity::operator= ( FrameworkEntityCref aCref )

Assignment operator.

Parameters:

FrameworkEntity const reference

Returns:
FrameworkEntity reference to (*this)

bool corelinux::FrameworkEntity::operator== ( FrameworkEntityCref aFrameworkEntity ) const

Equality operator.

Parameters:

FrameworkEntity const reference

Returns:
bool true if the same object instance

void corelinux::FrameworkEntity::setOid ( UniversalIdentifierCref aOid )

Set the object identifier for the instance.

Examples:
examp1.cpp.

corelinux::FrameworkEntity::void ( FrameworkEntityPtr aPointer ) [static]

destroy a point of className

pointer to className.

The documentation for this class was generated from the following files:

This is the CoreLinux++ Framework reference manual
Provided by The CoreLinux Consortium

corelinux::FrameworkEntity Class Reference

Public Methods

Static Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation