Public Types | Public Member Functions | List of all members
iattr::IAttributeMetaInfo Class Referenceabstract

Meta information describing single attribute. More...

#include <IAttributeMetaInfo.h>

Inheritance diagram for iattr::IAttributeMetaInfo:
istd::IChangeable istd::IPolymorphic iattr::CAttributeMetaInfo iattr::IEnumAttributeMetaInfo iattr::INumericAttributeMetaInfo icomp::IAttributeStaticInfo iattr::CEnumAttributeMetaInfo iattr::CNumericAttributeMetaInfo iattr::CEnumAttributeMetaInfo iattr::CNumericAttributeMetaInfo icomp::CCompositeComponentStaticInfo::AttrAsOptionalDelegator icomp::IRealAttributeStaticInfo icomp::TAttributeStaticInfo< Attribute >

Public Types

enum  AttributeFlags {
  AF_OBLIGATORY = 1 << 0, AF_NULLABLE = 1 << 1, AF_SINGLE = 1 << 2, AF_MULTIPLE = 1 << 3,
  AF_VALUE = 1 << 4, AF_READ_ONLY = 1 << 31
}
 Flags signalizing set of attribute properties. More...
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0, CF_ALL_DATA, CF_ANY, CF_DESTROYING,
  CF_DELEGATED, CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0, SO_OBSERVE = 1 << 0, SO_COPY = 1 << 1, SO_CLONE = 1 << 2,
  SO_COMPARE = 1 << 3, SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT, CM_WITHOUT_REFS, CM_WITH_REFS, CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

virtual QString GetAttributeDescription () const =0
 Get description of this attribute. More...
 
virtual const iser::IObjectGetAttributeDefaultValue () const =0
 Get default attribute value. More...
 
virtual QByteArray GetAttributeTypeId () const =0
 Return attribute type ID. More...
 
virtual int GetAttributeFlags () const =0
 Get flags of this attribute. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Meta information describing single attribute.

Definition at line 16 of file IAttributeMetaInfo.h.

Member Enumeration Documentation

Flags signalizing set of attribute properties.

Enumerator
AF_OBLIGATORY 

Active if user declared this attribute as obligatory.

AF_NULLABLE 

Active if this attribute can be unset (null).

Please note, that sometimes obligatory attributes can be nullable - for example for simple types default value can be taken.

AF_SINGLE 

Attribute is single type.

AF_MULTIPLE 

Attribute is multiple type.

AF_VALUE 

Attribute is simple value type.

AF_READ_ONLY 

Attribute is simple value type.

Definition at line 22 of file IAttributeMetaInfo.h.

Member Function Documentation

virtual const iser::IObject* iattr::IAttributeMetaInfo::GetAttributeDefaultValue ( ) const
pure virtual

Get default attribute value.

Returns
pointer to default attribute value, if set. Elsewhere it returns NULL.

Implemented in icomp::CCompositeComponentStaticInfo::AttrAsOptionalDelegator, icomp::TAttributeStaticInfo< Attribute >, and iattr::CAttributeMetaInfo.

virtual QString iattr::IAttributeMetaInfo::GetAttributeDescription ( ) const
pure virtual
virtual int iattr::IAttributeMetaInfo::GetAttributeFlags ( ) const
pure virtual
virtual QByteArray iattr::IAttributeMetaInfo::GetAttributeTypeId ( ) const
pure virtual

Return attribute type ID.

The attribute type ID identifies unique this attribute in factory.

See Also
istd::TIFactory::CreateInstance.

Implemented in icomp::CCompositeComponentStaticInfo::AttrAsOptionalDelegator, icomp::TAttributeStaticInfo< Attribute >, and iattr::CAttributeMetaInfo.

Referenced by icomp::CSimComponentContextBase::IsAttributeTypeCorrect().


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy