KeyValueTable<LabelAvoidance> Class

A lookup table that maps attribute values to LabelAvoidance values.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public abstract class KeyValueTable< LabelAvoidance > : 
	EngineObject,
	IDictionary< AttributeValue, LabelAvoidance >

Remarks

This class class represents a table that maps AttributeValue keys to LabelAvoidance values. The class is abstract and cannot be instantiated but the KeyedAttributeVariable<LabelAvoidance>.Table property returns an instance that maps keys to the result type of the attribute variable.

Table instances are usually populated in a configuration file with the help of Carmenta Studio but they can be populated or modified through code as well.

Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.

Inheritance Hierarchy

System.Object (not available in C#)
EngineObject
KeyValueTable<LabelAvoidance>

Platforms

Windows, Linux, Android

KeyValueTable<LabelAvoidance> Members

The KeyValueTable<LabelAvoidance> type has the following members.

Properties

Name	Description
Count	Gets the number of elements in the table.
IsDisposed	Gets a value that tells whether the current KeyValueTable<LabelAvoidance> has been disposed. Inherited from EngineObject
IsReadOnly	Gets a value that tells whether the table is read-only.
Item	Gets or sets the element with the specified key.
Keys	Gets an ICollection containing the keys in the table.
NativeHandle	Gets the native Carmenta Engine kernel object the current KeyValueTable<LabelAvoidance> represents. Inherited from EngineObject
Values	Gets an ICollection containing the values in the table.

Methods

Name	Description
Add	Adds a new element to the table.
AddRange	Adds the elements in the specified collection to the KeyValueTable<LabelAvoidance>.
Clear	Removes all elements from the table.
Clone	Creates a copy of an object. Inherited from EngineObject
Contains	Determines whether the table contains the specified element.
ContainsKey	Determines whether the table contains an element with the specified key.
CopyTo	Copies all elements in the table to a compatible one-dimensional array, starting at the specified index of the target array.
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject
GetEnumerator	Returns an enumerator that iterates through all elements in the table.
Remove	Removes element with the specified key from the table.
TryGetValue	Gets the value associated with the specified key.

KeyedLabelAvoidanceTable Class

A lookup table that maps attribute values to LabelAvoidance values.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class KeyedLabelAvoidanceTable : public EngineObject

C++ Smart Pointer Declaration

typedef Ptr<KeyedLabelAvoidanceTable> KeyedLabelAvoidanceTablePtr;

Remarks

This class class represents a table that maps AttributeValue keys to LabelAvoidance values. The class is abstract and cannot be instantiated but the KeyedLabelAvoidanceAttributeVariable::table property returns an instance that maps keys to the result type of the attribute variable.

Table instances are usually populated in a configuration file with the help of Carmenta Studio but they can be populated or modified through code as well.

Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.

Inheritance Hierarchy

EngineObject
KeyedLabelAvoidanceTable

Platforms

Windows, Linux, Android

KeyedLabelAvoidanceTable Members

The KeyedLabelAvoidanceTable type has the following members.

Properties

Name	Description
keys	Gets an collection containing the keys in the table.
size	Gets the number of elements in the table.

Methods

Name	Description
add	Adds a new element to the table.
clear	Removes all elements from the table.
clone	Creates a copy of an object. Inherited from EngineObject
containsKey	Determines whether the table contains an element with the specified key.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
remove	Removes element with the specified key from the table.
size	Gets the number of elements in the table.
tryGetValue	Gets the value associated with the specified key.

KeyedLabelAvoidanceTable Class

A lookup table that maps attribute values to LabelAvoidance values.

Package: com.carmenta.engine.core
JAR file: CECore.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public abstract KeyedLabelAvoidanceTable extends EngineObject implements 
	Map< Object, LabelAvoidance >

Remarks

This class class represents a table that maps Object keys to LabelAvoidance values. The class is abstract and cannot be instantiated but the KeyedLabelAvoidanceAttributeVariable.table property returns an instance that maps keys to the result type of the attribute variable.

Table instances are usually populated in a configuration file with the help of Carmenta Studio but they can be populated or modified through code as well.

Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.

Inheritance Hierarchy

System::Object (not available in Java)
EngineObject
KeyedLabelAvoidanceTable

Platforms

Windows, Linux, Android

KeyedLabelAvoidanceTable Members

The KeyedLabelAvoidanceTable type has the following members.

Properties

Name	Description
isDisposed	Gets a value that tells whether the current KeyedLabelAvoidanceTable has been disposed. Inherited from EngineObject
isEmpty	Gets a value that tells whether the table is empty.
size	Gets the number of elements in the table.

Methods

Name	Description
clear	Removes all elements from the table.
clone	Creates a copy of an object. Inherited from EngineObject
containsKey	Determines whether the table contains an element with the specified key.
containsValue	Determines whether the table contains an element with the specified value.
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
entrySet	Gets all elements in the table.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
get	Gets the value associated with the specified key.
keySet	Gets all keys in the table.
put	Adds an element with the specified key and value to the table.
putAll	Adds all elements in the specified map to the table.
remove	Removes element with the specified key from the table.
size	Gets the number of elements in the table.
values	Gets a collection that contains all values in the table.

KeyedLabelAvoidanceTable Class

A lookup table that maps attribute values to LabelAvoidance values.

Module: Carmenta.Engine.Core (in Core.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class KeyedLabelAvoidanceTable ( EngineObject )

Remarks

Table instances are usually populated in a configuration file with the help of Carmenta Studio but they can be populated or modified through code as well.

Please see Attribute Controlled Visualization for more information on how attribute variables are used to control visualization.

Inheritance Hierarchy

EngineObject
KeyedLabelAvoidanceTable

Platforms

Windows, Linux, Android

KeyedLabelAvoidanceTable Members

The KeyedLabelAvoidanceTable type has the following members.

Properties

Name	Description
item	Gets or sets the value with the specified key.
size	Gets the number of elements in the table.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
size	Gets the number of elements in the table.

KeyValueTable<LabelAvoidance> Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyValueTable<LabelAvoidance> Members

KeyedLabelAvoidanceTable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedLabelAvoidanceTable Members

KeyedLabelAvoidanceTable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedLabelAvoidanceTable Members

KeyedLabelAvoidanceTable Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

KeyedLabelAvoidanceTable Members