org.lflang.target.property.ClockSyncModeProperty Class Reference

The mode of clock synchronization to be used in federated programs. More...

Inherits org.lflang.target.property.TargetProperty< ClockSyncMode, ClockSyncModeType >.

Public Member Functions
Optional< Element >	astElementFromConfig (TargetConfig config)
boolean	checkType (KeyValuePair pair, MessageReporter reporter)
	If the given key-value pair does not match the type required by this target property, report an error through the given reporter.
boolean	equals (Object obj)
	Return true if the given object is an instance of a class with the same name.
ClockSyncMode	fromAst (Element node, MessageReporter reporter)
int	hashCode ()
ClockSyncMode	initialValue ()
boolean	loadFromFederate ()
	Return true if this property is to be loaded from imported federates, false otherwise.
boolean	loadFromFederation ()
	Return true if this property is to be loaded by federates when specified at the level of the federation, false otherwise.
boolean	loadFromImport ()
	Return true if this property is to be loaded from imported files, false otherwise.
String	name ()
final void	override (TargetConfig config, T value)
	Replace the value assigned to this target property in the given config with the given value.
Element	toAstElement (ClockSyncMode value)
abstract Element	toAstElement (T value)
	Return an AST node that represents this target property and the value currently assigned to it.
String	toString ()
void	update (TargetConfig config, T value)
	Update the given configuration using the given value.
void	validate (TargetConfig config, MessageReporter reporter)
	Override this method to implement additional checks.

Public Attributes
final S	type
	The type of values assignable to this target property.

Static Public Attributes
static final ClockSyncModeProperty	INSTANCE = new ClockSyncModeProperty()
	Singleton target property instance.

Protected Member Functions
T	fromJSON (JsonElement element, MessageReporter reporter)
	Return a value based on the given JSON element.
ClockSyncMode	fromString (String string, MessageReporter reporter)

Detailed Description

The mode of clock synchronization to be used in federated programs.

The default is 'initial'.

Member Function Documentation

astElementFromConfig()

Optional< Element > org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.astElementFromConfig ( TargetConfig config )

inherited

checkType()

boolean org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.checkType ( KeyValuePair pair, MessageReporter reporter )

inherited

If the given key-value pair does not match the type required by this target property, report an error through the given reporter.

Parameters

pair	The ast node that matches this target property.
reporter	The reporter to issue an error through if the given key-value pair does not match the type required by this property.

equals()

boolean org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.equals ( Object obj )

inherited

Return true if the given object is an instance of a class with the same name.

Parameters

obj	The object to compare this instance to.

fromAst()

ClockSyncMode org.lflang.target.property.ClockSyncModeProperty.fromAst	(	Element	node,
		MessageReporter	reporter )

fromJSON()

T org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.fromJSON ( JsonElement element, MessageReporter reporter )

protectedinherited

Return a value based on the given JSON element.

Parameters

element	The JSON element to produce a value from/
reporter	A message reporter for reporting issues.

fromString()

ClockSyncMode org.lflang.target.property.ClockSyncModeProperty.fromString ( String string, MessageReporter reporter )

protected

hashCode()

int org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.hashCode ( )

inherited

initialValue()

ClockSyncMode org.lflang.target.property.ClockSyncModeProperty.initialValue

(

)

loadFromFederate()

boolean org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.loadFromFederate ( )

inherited

Return true if this property is to be loaded from imported federates, false otherwise.

loadFromFederation()

boolean org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.loadFromFederation ( )

inherited

Return true if this property is to be loaded by federates when specified at the level of the federation, false otherwise.

loadFromImport()

boolean org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.loadFromImport ( )

inherited

Return true if this property is to be loaded from imported files, false otherwise.

name()

String org.lflang.target.property.ClockSyncModeProperty.name

(

)

override()

final void org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.override ( TargetConfig config, T value )

inherited

Replace the value assigned to this target property in the given config with the given value.

Parameters

config	The configuration to change.
value	The new value to assign.

toAstElement() [1/2]

Element org.lflang.target.property.ClockSyncModeProperty.toAstElement

(

ClockSyncMode

value

)

toAstElement() [2/2]

abstract Element org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.toAstElement ( T value )

abstractinherited

Return an AST node that represents this target property and the value currently assigned to it.

toString()

String org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.toString ( )

inherited

update()

void org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.update ( TargetConfig config, T value )

inherited

Update the given configuration using the given value.

The default implementation simply assigns the given value, overriding whatever value might have been assigned before.

Parameters

config	The configuration to update.
value	The value to perform the update with.

validate()

void org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.validate ( TargetConfig config, MessageReporter reporter )

inherited

Override this method to implement additional checks.

The base implementation does nothing.

This method is meant to perform additional validation above and beyond checking target support and type checking which are done automatically.

Parameters

config	The target configuration to check against.
reporter	A reporter for reporting errors.

Member Data Documentation

INSTANCE

final ClockSyncModeProperty org.lflang.target.property.ClockSyncModeProperty.INSTANCE = new ClockSyncModeProperty()

static

Singleton target property instance.

type

final S org.lflang.target.property.TargetProperty< T, S extends TargetPropertyType >.type

inherited

The type of values assignable to this target property.

---

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

• /Users/runner/work/lingua-franca/lingua-franca/core/src/main/java/org/lflang/target/property/ClockSyncModeProperty.java