Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
EnvironmentKeyframe Class Reference

An object in the Physical Workspace. More...

Public Member Functions

int getTime ()
 Returns the time the keyframe is set to exist at, in seconds. More...
 
void setTime (int)
 Sets the time the keyframe exists at, in seconds. More...
 
int getEnvironmentOptionsCount ()
 Returns how many different environment value properties ("CO", "Sunlight", etc) are in the key frame. More...
 
vector< QString > getEnvironmentKeys ()
 Returns the names of all the environment value properties ("CO", "Sunlight", etc) are in the key frame. More...
 
EnvironmentOptions getEnvironment (QString)
 Returns the environment properties for the environment value property type passed. More...
 

Detailed Description

An object in the Physical Workspace.

Member Function Documentation

◆ getEnvironment()

EnvironmentOptions EnvironmentKeyframe::getEnvironment ( QString  )

Returns the environment properties for the environment value property type passed.

Parameters
env,Nameof the environment property type to get the properties for. Like "CO", "Sunlight", etc.
Returns
EnvironmentOptions, the enivronment options for the given environment value type.

◆ getEnvironmentKeys()

vector< QString > EnvironmentKeyframe::getEnvironmentKeys ( )

Returns the names of all the environment value properties ("CO", "Sunlight", etc) are in the key frame.

Returns
vector<QString>, a list with an entry for each environment property name in the keyframe.

◆ getEnvironmentOptionsCount()

int EnvironmentKeyframe::getEnvironmentOptionsCount ( )

Returns how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.

Returns
int, value is how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.

◆ getTime()

int EnvironmentKeyframe::getTime ( )

Returns the time the keyframe is set to exist at, in seconds.

Returns
int, value is the time the keyframe resides at, in seconds.

◆ setTime()

void EnvironmentKeyframe::setTime ( int  )

Sets the time the keyframe exists at, in seconds.

Parameters
time,valueis the time the keyframe resides at, in seconds.

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