TMESemanticDescription

@interface TMESemanticDescription : NSObject <NSCopying>

This class models an ALN concept expression as the conjunction of CCN, CGT, CLT, C∀ components, stored in collections of AtomicConcept, CardinalityRole and UniversalRole class instances.

Instances of this class are backed by native data structures, and as such they require special treatment for memory management, therefore they can only be created via the DataFactory instance held by the reasoner (which automatically ties their lifecycle to that of the enclosing objects).

Unless otherwise stated, SemanticDescription objects returned by the reasoner instance should not be mutated unless they have been copied beforehand, otherwise an exception is thrown.

See

TMEDataFactory

Properties

  • Atomic concept conjuncts referenced in this description.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<TMEAtomicConcept *> *_Nullable atomicConcepts;

    Swift

    var atomicConcepts: [TMEAtomicConcept]? { get }

  • Negated atomic concept conjuncts referenced in this description.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<TMEAtomicConcept *> *_Nullable negatedConcepts;

    Swift

    var negatedConcepts: [TMEAtomicConcept]? { get }

  • Minimum cardinality restriction conjuncts referenced in this description.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<TMECardinalityRole *> *_Nullable greaterThanRoles;

    Swift

    var greaterThanRoles: [TMECardinalityRole]? { get }

  • Maximum cardinality restriction conjuncts referenced in this description.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<TMECardinalityRole *> *_Nullable lessThanRoles;

    Swift

    var lessThanRoles: [TMECardinalityRole]? { get }

  • Value restriction conjuncts referenced in this description.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<TMEUniversalRole *> *_Nullable universalRoles;

    Swift

    var universalRoles: [TMEUniversalRole]? { get }

  • Adds the specified atomic concept to this description.

    Declaration

    Objective-C

    - (void)addAtomicConcept:(nonnull TMEAtomicConcept *)atomicConcept;

    Swift

    func addAtomicConcept(_ atomicConcept: TMEAtomicConcept)

    Parameters

    atomicConcept

    Concept to add.

  • Adds the atomic concept representing the specified OWL class to this description.

    Declaration

    Objective-C

    - (void)addAtomicConceptWithOwlClass:(nonnull id<OWLClass>)owlClass;

    Parameters

    owlClass

    Class representing the concept.

  • Adds the specified atomic concepts to this description.

    Declaration

    Objective-C

    - (void)addAtomicConcepts:(nonnull NSArray<TMEAtomicConcept *> *)atomicConcepts;

    Swift

    func addAtomicConcepts(_ atomicConcepts: [TMEAtomicConcept])

    Parameters

    atomicConcepts

    Concepts to add.

  • Adds the specified negated concept to this description.

    Declaration

    Objective-C

    - (void)addNegatedConcept:(nonnull TMEAtomicConcept *)negatedConcept;

    Swift

    func addNegatedConcept(_ negatedConcept: TMEAtomicConcept)

    Parameters

    negatedConcept

    Negated concept to add.

  • Adds the negated concept representing the complement of the specified OWL class to this description.

    Declaration

    Objective-C

    - (void)addNegatedConceptWithOwlClass:(nonnull id<OWLClass>)owlClass;

    Parameters

    owlClass

    Class representing the concept.

  • Adds the specified negated concepts to this description.

    Declaration

    Objective-C

    - (void)addNegatedConcepts:
    (nonnull NSArray<TMEAtomicConcept *> *)negatedConcepts;

    Swift

    func addNegatedConcepts(_ negatedConcepts: [TMEAtomicConcept])

    Parameters

    negatedConcepts

    Negated concepts to add.

  • Adds the specified minimum cardinality restriction to this description.

    Declaration

    Objective-C

    - (void)addGreaterThanRole:(nonnull TMECardinalityRole *)greaterThanRole;

    Swift

    func addGreaterThanRole(_ greaterThanRole: TMECardinalityRole)

    Parameters

    greaterThanRole

    Minimum cardinality restriction to add.

  • Creates and adds a new minimum cardinality restriction to this description.

    Declaration

    Objective-C

    - (void)addGreaterThanRoleWithProperty:(nonnull id<OWLObjectProperty>)property
                           cardinality:(NSUInteger)cardinality;

    Parameters

    property

    Property of the restriction.
    cardinality

    Cardinality of the restriction.

  • Adds the specified minimum cardinality restrictions to this description.

    Declaration

    Objective-C

    - (void)addGreaterThanRoles:
    (nonnull NSArray<TMECardinalityRole *> *)greaterThanRoles;

    Swift

    func addGreaterThanRoles(_ greaterThanRoles: [TMECardinalityRole])

    Parameters

    greaterThanRoles

    Minimum cardinality restrictions to add.

  • Adds the specified maximum cardinality restriction to this description.

    Declaration

    Objective-C

    - (void)addLessThanRole:(nonnull TMECardinalityRole *)lessThanRole;

    Swift

    func addLessThanRole(_ lessThanRole: TMECardinalityRole)

    Parameters

    lessThanRole

    Maximum cardinality restriction to add.

  • Creates and adds a new maximum cardinality restriction to this description.

    Declaration

    Objective-C

    - (void)addLessThanRoleWithProperty:(nonnull id<OWLObjectProperty>)property
                        cardinality:(NSUInteger)cardinality;

    Parameters

    property

    Property of the restriction.
    cardinality

    Cardinality of the restriction.

  • Adds the specified maximum cardinality restrictions to this description.

    Declaration

    Objective-C

    - (void)addLessThanRoles:(nonnull NSArray<TMECardinalityRole *> *)lessThanRoles;

    Swift

    func addLessThanRoles(_ lessThanRoles: [TMECardinalityRole])

    Parameters

    lessThanRoles

    Maximum cardinality restrictions to add.

  • Adds the specified value restriction to this description.

    Declaration

    Objective-C

    - (void)addUniversalRole:(nonnull TMEUniversalRole *)universalRole;

    Swift

    func addUniversalRole(_ universalRole: TMEUniversalRole)

    Parameters

    universalRole

    Value restriction to add.

  • Creates and adds a new value restriction to this description.

    Declaration

    Objective-C

    - (void)addUniversalRoleWithProperty:(nonnull id<OWLObjectProperty>)property
                              filler:(nonnull TMESemanticDescription *)filler;

    Parameters

    property

    Property of the restriction.
    filler

    Filler of the restriction.

  • Adds the specified value restrictions to this description.

    Declaration

    Objective-C

    - (void)addUniversalRoles:(nonnull NSArray<TMEUniversalRole *> *)universalRoles;

    Swift

    func addUniversalRoles(_ universalRoles: [TMEUniversalRole])

    Parameters

    universalRoles

    Value restrictions to add.

  • Performs the intersection between this description and another. Only the current instance is mutated.

    Declaration

    Objective-C

    - (void)intersectWithDescription:(nonnull TMESemanticDescription *)description;

    Swift

    func intersect(with description: TMESemanticDescription)

    Parameters

    description

    Description to perform the intersection with.