CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Member Functions | List of all members
ctkObjectClassDefinition Struct Referenceabstract

#include <Libs/PluginFramework/service/metatype/ctkObjectClassDefinition.h>

Public Types

enum  Filter { REQUIRED , OPTIONAL , ALL }
 

Public Member Functions

virtual QList< ctkAttributeDefinitionPtrgetAttributeDefinitions (Filter filter)=0
 
virtual QString getDescription () const =0
 
virtual QByteArray getIcon (int size) const =0
 
virtual QString getID () const =0
 
virtual QString getName () const =0
 
virtual ~ctkObjectClassDefinition ()
 

Detailed Description

Description for the data type information of an objectclass.

Definition at line 33 of file ctkObjectClassDefinition.h.

Member Enumeration Documentation

◆ Filter

Enumerator
REQUIRED 

Argument for getAttributeDefinitions().

REQUIRED indicates that only the required definitions are returned.

OPTIONAL 

Argument for getAttributeDefinitions().

OPTIONAL indicates that only the optional definitions are returned.

ALL 

Argument for getAttributeDefinitions().

ALL indicates that all the definitions are returned.

Definition at line 36 of file ctkObjectClassDefinition.h.

Constructor & Destructor Documentation

◆ ~ctkObjectClassDefinition()

virtual ctkObjectClassDefinition::~ctkObjectClassDefinition ( )
inlinevirtual

Definition at line 59 of file ctkObjectClassDefinition.h.

Member Function Documentation

◆ getAttributeDefinitions()

virtual QList<ctkAttributeDefinitionPtr> ctkObjectClassDefinition::getAttributeDefinitions ( Filter  filter)
pure virtual

Return the attribute definitions for this object class.

Return a set of attributes. The filter parameter can distinguish between ALL,REQUIRED or the OPTIONAL attributes.

Parameters
filterALL,REQUIRED,OPTIONAL
Returns
A list of attribute definitions, which is empty if no attributes are selected

◆ getDescription()

virtual QString ctkObjectClassDefinition::getDescription ( ) const
pure virtual

Return a description of this object class.

The description may be localized.

Returns
The description of this object class.

◆ getIcon()

virtual QByteArray ctkObjectClassDefinition::getIcon ( int  size) const
pure virtual

Return a QByteArray object that can be used to create an icon from.

Indicate the size and return a QByteAray object containing an icon. The returned icon maybe larger or smaller than the indicated size.

The icon may depend on the localization.

Parameters
sizeRequested size of an icon, e.g. a 16x16 pixels icon then size = 16
Returns
A QByteArray holding an icon or an empty QByteArray.

◆ getID()

virtual QString ctkObjectClassDefinition::getID ( ) const
pure virtual

Return the id of this object class.

ctkObjectClassDefintion objects share a global namespace in the registry. They share this aspect with LDAP/X.500 attributes. In these standards the OSI Object Identifier (OID) is used to uniquely identify object classes. If such an OID exists, (which can be requested at several standard organisations and many companies already have a node in the tree) it can be returned here. Otherwise, a unique id should be returned which can be a class name combined with a reverse domain name, or generated with a GUID algorithm. Note that all LDAP defined object classes already have an OID associated. It is strongly advised to define the object classes from existing LDAP schemes which will give the OID for free. Many such schemes exist ranging from postal addresses to DHCP parameters.

Returns
The id of this object class.

◆ getName()

virtual QString ctkObjectClassDefinition::getName ( ) const
pure virtual

Return the name of this object class.

The name may be localized.

Returns
The name of this object class.

The documentation for this struct was generated from the following file: